Class: OCI::Core::VirtualNetworkClient
- Inherits:
-
Object
- Object
- OCI::Core::VirtualNetworkClient
- Defined in:
- lib/oci/core/virtual_network_client.rb
Overview
Use the Core Services API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes. For more information, see the console documentation for the Networking, Compute, and Block Volume services. The required permissions are documented in the Details for the Core Services article.
Instance Attribute Summary collapse
-
#api_client ⇒ OCI::ApiClient
readonly
Client used to make HTTP requests.
-
#endpoint ⇒ String
readonly
Fully qualified endpoint URL.
-
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
-
#retry_config ⇒ OCI::Retry::RetryConfig
readonly
The default retry configuration to apply to all operations in this service client.
Instance Method Summary collapse
-
#add_drg_route_distribution_statements(drg_route_distribution_id, add_drg_route_distribution_statements_details, opts = {}) ⇒ Response
Adds one or more route distribution statements to the specified route distribution.
-
#add_drg_route_rules(drg_route_table_id, add_drg_route_rules_details, opts = {}) ⇒ Response
Adds one or more static route rules to the specified DRG route table.
-
#add_ipv6_subnet_cidr(subnet_id, add_subnet_ipv6_cidr_details, opts = {}) ⇒ Response
Add an IPv6 prefix to a subnet.
-
#add_ipv6_vcn_cidr(vcn_id, opts = {}) ⇒ Response
Add an IPv6 prefix to a VCN.
-
#add_network_security_group_security_rules(network_security_group_id, add_network_security_group_security_rules_details, opts = {}) ⇒ Response
Adds one or more security rules to the specified network security group.
-
#add_public_ip_pool_capacity(public_ip_pool_id, add_public_ip_pool_capacity_details, opts = {}) ⇒ Response
Adds some or all of a CIDR block to a public IP pool.
-
#add_vcn_cidr(vcn_id, add_vcn_cidr_details, opts = {}) ⇒ Response
Adds a CIDR block to a VCN.
-
#advertise_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.
-
#attach_service_id(service_gateway_id, attach_service_details, opts = {}) ⇒ Response
Adds the specified Service to the list of enabled
Service
objects for the specified gateway. -
#bulk_add_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_add_virtual_circuit_public_prefixes_details, opts = {}) ⇒ Response
Adds one or more customer public IP prefixes to the specified public virtual circuit.
-
#bulk_delete_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_delete_virtual_circuit_public_prefixes_details, opts = {}) ⇒ Response
Removes one or more customer public IP prefixes from the specified public virtual circuit.
-
#change_byoip_range_compartment(byoip_range_id, change_byoip_range_compartment_details, opts = {}) ⇒ Response
Moves a BYOIP CIDR block to a different compartment.
-
#change_capture_filter_compartment(capture_filter_id, change_capture_filter_compartment_details, opts = {}) ⇒ Response
Moves a capture filter to a new compartment in the same tenancy.
-
#change_cpe_compartment(cpe_id, change_cpe_compartment_details, opts = {}) ⇒ Response
Moves a CPE object into a different compartment within the same tenancy.
-
#change_cross_connect_compartment(cross_connect_id, change_cross_connect_compartment_details, opts = {}) ⇒ Response
Moves a cross-connect into a different compartment within the same tenancy.
-
#change_cross_connect_group_compartment(cross_connect_group_id, change_cross_connect_group_compartment_details, opts = {}) ⇒ Response
Moves a cross-connect group into a different compartment within the same tenancy.
-
#change_dhcp_options_compartment(dhcp_id, change_dhcp_options_compartment_details, opts = {}) ⇒ Response
Moves a set of DHCP options into a different compartment within the same tenancy.
-
#change_drg_compartment(drg_id, change_drg_compartment_details, opts = {}) ⇒ Response
Moves a DRG into a different compartment within the same tenancy.
-
#change_internet_gateway_compartment(ig_id, change_internet_gateway_compartment_details, opts = {}) ⇒ Response
Moves an internet gateway into a different compartment within the same tenancy.
-
#change_ip_sec_connection_compartment(ipsc_id, change_ip_sec_connection_compartment_details, opts = {}) ⇒ Response
Moves an IPSec connection into a different compartment within the same tenancy.
-
#change_local_peering_gateway_compartment(local_peering_gateway_id, change_local_peering_gateway_compartment_details, opts = {}) ⇒ Response
Moves a local peering gateway into a different compartment within the same tenancy.
-
#change_nat_gateway_compartment(nat_gateway_id, change_nat_gateway_compartment_details, opts = {}) ⇒ Response
Moves a NAT gateway into a different compartment within the same tenancy.
-
#change_network_security_group_compartment(network_security_group_id, change_network_security_group_compartment_details, opts = {}) ⇒ Response
Moves a network security group into a different compartment within the same tenancy.
-
#change_public_ip_compartment(public_ip_id, change_public_ip_compartment_details, opts = {}) ⇒ Response
Moves a public IP into a different compartment within the same tenancy.
-
#change_public_ip_pool_compartment(public_ip_pool_id, change_public_ip_pool_compartment_details, opts = {}) ⇒ Response
Moves a public IP pool to a different compartment.
-
#change_remote_peering_connection_compartment(remote_peering_connection_id, change_remote_peering_connection_compartment_details, opts = {}) ⇒ Response
Moves a remote peering connection (RPC) into a different compartment within the same tenancy.
-
#change_route_table_compartment(rt_id, change_route_table_compartment_details, opts = {}) ⇒ Response
Moves a route table into a different compartment within the same tenancy.
-
#change_security_list_compartment(security_list_id, change_security_list_compartment_details, opts = {}) ⇒ Response
Moves a security list into a different compartment within the same tenancy.
-
#change_service_gateway_compartment(service_gateway_id, change_service_gateway_compartment_details, opts = {}) ⇒ Response
Moves a service gateway into a different compartment within the same tenancy.
-
#change_subnet_compartment(subnet_id, change_subnet_compartment_details, opts = {}) ⇒ Response
Moves a subnet into a different compartment within the same tenancy.
-
#change_vcn_compartment(vcn_id, change_vcn_compartment_details, opts = {}) ⇒ Response
Moves a VCN into a different compartment within the same tenancy.
-
#change_virtual_circuit_compartment(virtual_circuit_id, change_virtual_circuit_compartment_details, opts = {}) ⇒ Response
Moves a virtual circuit into a different compartment within the same tenancy.
-
#change_vlan_compartment(vlan_id, change_vlan_compartment_details, opts = {}) ⇒ Response
Moves a VLAN into a different compartment within the same tenancy.
-
#change_vtap_compartment(vtap_id, change_vtap_compartment_details, opts = {}) ⇒ Response
Moves a VTAP to a new compartment within the same tenancy.
-
#connect_local_peering_gateways(local_peering_gateway_id, connect_local_peering_gateways_details, opts = {}) ⇒ Response
Connects this local peering gateway (LPG) to another one in the same region.
-
#connect_remote_peering_connections(remote_peering_connection_id, connect_remote_peering_connections_details, opts = {}) ⇒ Response
Connects this RPC to another one in a different region.
-
#create_byoip_range(create_byoip_range_details, opts = {}) ⇒ Response
Creates a subrange of the BYOIP CIDR block.
-
#create_capture_filter(create_capture_filter_details, opts = {}) ⇒ Response
Creates a virtual test access point (VTAP) capture filter in the specified compartment.
-
#create_cpe(create_cpe_details, opts = {}) ⇒ Response
Creates a new virtual customer-premises equipment (CPE) object in the specified compartment.
-
#create_cross_connect(create_cross_connect_details, opts = {}) ⇒ Response
Creates a new cross-connect.
-
#create_cross_connect_group(create_cross_connect_group_details, opts = {}) ⇒ Response
Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect.
-
#create_dhcp_options(create_dhcp_details, opts = {}) ⇒ Response
Creates a new set of DHCP options for the specified VCN.
-
#create_drg(create_drg_details, opts = {}) ⇒ Response
Creates a new dynamic routing gateway (DRG) in the specified compartment.
-
#create_drg_attachment(create_drg_attachment_details, opts = {}) ⇒ Response
Attaches the specified DRG to the specified network resource.
-
#create_drg_route_distribution(create_drg_route_distribution_details, opts = {}) ⇒ Response
Creates a new route distribution for the specified DRG.
-
#create_drg_route_table(create_drg_route_table_details, opts = {}) ⇒ Response
Creates a new DRG route table for the specified DRG.
-
#create_internet_gateway(create_internet_gateway_details, opts = {}) ⇒ Response
Creates a new internet gateway for the specified VCN.
-
#create_ip_sec_connection(create_ip_sec_connection_details, opts = {}) ⇒ Response
Creates a new IPSec connection between the specified DRG and CPE.
-
#create_ipv6(create_ipv6_details, opts = {}) ⇒ Response
Creates an IPv6 for the specified VNIC.
-
#create_local_peering_gateway(create_local_peering_gateway_details, opts = {}) ⇒ Response
Creates a new local peering gateway (LPG) for the specified VCN.
-
#create_nat_gateway(create_nat_gateway_details, opts = {}) ⇒ Response
Creates a new NAT gateway for the specified VCN.
-
#create_network_security_group(create_network_security_group_details, opts = {}) ⇒ Response
Creates a new network security group for the specified VCN.
-
#create_private_ip(create_private_ip_details, opts = {}) ⇒ Response
Creates a secondary private IP for the specified VNIC.
-
#create_public_ip(create_public_ip_details, opts = {}) ⇒ Response
Creates a public IP.
-
#create_public_ip_pool(create_public_ip_pool_details, opts = {}) ⇒ Response
Creates a public IP pool.
-
#create_remote_peering_connection(create_remote_peering_connection_details, opts = {}) ⇒ Response
Creates a new remote peering connection (RPC) for the specified DRG.
-
#create_route_table(create_route_table_details, opts = {}) ⇒ Response
Creates a new route table for the specified VCN.
-
#create_security_list(create_security_list_details, opts = {}) ⇒ Response
Creates a new security list for the specified VCN.
-
#create_service_gateway(create_service_gateway_details, opts = {}) ⇒ Response
Creates a new service gateway in the specified compartment.
-
#create_subnet(create_subnet_details, opts = {}) ⇒ Response
Creates a new subnet in the specified VCN.
-
#create_vcn(create_vcn_details, opts = {}) ⇒ Response
Creates a new virtual cloud network (VCN).
-
#create_virtual_circuit(create_virtual_circuit_details, opts = {}) ⇒ Response
Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect.
-
#create_vlan(create_vlan_details, opts = {}) ⇒ Response
Creates a VLAN in the specified VCN and the specified compartment.
-
#create_vtap(create_vtap_details, opts = {}) ⇒ Response
Creates a virtual test access point (VTAP) in the specified compartment.
-
#delete_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Deletes the specified
ByoipRange
resource. -
#delete_capture_filter(capture_filter_id, opts = {}) ⇒ Response
Deletes the specified VTAP capture filter.
-
#delete_cpe(cpe_id, opts = {}) ⇒ Response
Deletes the specified CPE object.
-
#delete_cross_connect(cross_connect_id, opts = {}) ⇒ Response
Deletes the specified cross-connect.
-
#delete_cross_connect_group(cross_connect_group_id, opts = {}) ⇒ Response
Deletes the specified cross-connect group.
-
#delete_dhcp_options(dhcp_id, opts = {}) ⇒ Response
Deletes the specified set of DHCP options, but only if it's not associated with a subnet.
-
#delete_drg(drg_id, opts = {}) ⇒ Response
Deletes the specified DRG.
-
#delete_drg_attachment(drg_attachment_id, opts = {}) ⇒ Response
Detaches a DRG from a network resource by deleting the corresponding
DrgAttachment
resource. -
#delete_drg_route_distribution(drg_route_distribution_id, opts = {}) ⇒ Response
Deletes the specified route distribution.
-
#delete_drg_route_table(drg_route_table_id, opts = {}) ⇒ Response
Deletes the specified DRG route table.
-
#delete_internet_gateway(ig_id, opts = {}) ⇒ Response
Deletes the specified internet gateway.
-
#delete_ip_sec_connection(ipsc_id, opts = {}) ⇒ Response
Deletes the specified IPSec connection.
-
#delete_ipv6(ipv6_id, opts = {}) ⇒ Response
Unassigns and deletes the specified IPv6.
-
#delete_local_peering_gateway(local_peering_gateway_id, opts = {}) ⇒ Response
Deletes the specified local peering gateway (LPG).
-
#delete_nat_gateway(nat_gateway_id, opts = {}) ⇒ Response
Deletes the specified NAT gateway.
-
#delete_network_security_group(network_security_group_id, opts = {}) ⇒ Response
Deletes the specified network security group.
-
#delete_private_ip(private_ip_id, opts = {}) ⇒ Response
Unassigns and deletes the specified private IP.
-
#delete_public_ip(public_ip_id, opts = {}) ⇒ Response
Unassigns and deletes the specified public IP (either ephemeral or reserved).
-
#delete_public_ip_pool(public_ip_pool_id, opts = {}) ⇒ Response
Deletes the specified public IP pool.
-
#delete_remote_peering_connection(remote_peering_connection_id, opts = {}) ⇒ Response
Deletes the remote peering connection (RPC).
-
#delete_route_table(rt_id, opts = {}) ⇒ Response
Deletes the specified route table, but only if it's not associated with a subnet.
-
#delete_security_list(security_list_id, opts = {}) ⇒ Response
Deletes the specified security list, but only if it's not associated with a subnet.
-
#delete_service_gateway(service_gateway_id, opts = {}) ⇒ Response
Deletes the specified service gateway.
-
#delete_subnet(subnet_id, opts = {}) ⇒ Response
Deletes the specified subnet, but only if there are no instances in the subnet.
-
#delete_vcn(vcn_id, opts = {}) ⇒ Response
Deletes the specified VCN.
-
#delete_virtual_circuit(virtual_circuit_id, opts = {}) ⇒ Response
Deletes the specified virtual circuit.
-
#delete_vlan(vlan_id, opts = {}) ⇒ Response
Deletes the specified VLAN, but only if there are no VNICs in the VLAN.
-
#delete_vtap(vtap_id, opts = {}) ⇒ Response
Deletes the specified VTAP.
-
#detach_service_id(service_gateway_id, detach_service_details, opts = {}) ⇒ Response
Removes the specified Service from the list of enabled
Service
objects for the specified gateway. -
#get_all_drg_attachments(drg_id, opts = {}) ⇒ Response
Returns a complete list of DRG attachments that belong to a particular DRG.
-
#get_allowed_ike_ip_sec_parameters(opts = {}) ⇒ Response
The parameters allowed for IKE IPSec tunnels.
-
#get_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Gets the
ByoipRange
resource. -
#get_capture_filter(capture_filter_id, opts = {}) ⇒ Response
Gets information about the specified VTAP capture filter.
-
#get_cpe(cpe_id, opts = {}) ⇒ Response
Gets the specified CPE's information.
-
#get_cpe_device_config_content(cpe_id, opts = {}, &block) ⇒ Response
Renders a set of CPE configuration content that can help a network engineer configure the actual CPE device (for example, a hardware router) represented by the specified Cpe object.
-
#get_cpe_device_shape(cpe_device_shape_id, opts = {}) ⇒ Response
Gets the detailed information about the specified CPE device type.
-
#get_cross_connect(cross_connect_id, opts = {}) ⇒ Response
Gets the specified cross-connect's information.
-
#get_cross_connect_group(cross_connect_group_id, opts = {}) ⇒ Response
Gets the specified cross-connect group's information.
-
#get_cross_connect_letter_of_authority(cross_connect_id, opts = {}) ⇒ Response
Gets the Letter of Authority for the specified cross-connect.
-
#get_cross_connect_status(cross_connect_id, opts = {}) ⇒ Response
Gets the status of the specified cross-connect.
-
#get_dhcp_options(dhcp_id, opts = {}) ⇒ Response
Gets the specified set of DHCP options.
-
#get_drg(drg_id, opts = {}) ⇒ Response
Gets the specified DRG's information.
-
#get_drg_attachment(drg_attachment_id, opts = {}) ⇒ Response
Gets the
DrgAttachment
resource. -
#get_drg_redundancy_status(drg_id, opts = {}) ⇒ Response
Gets the redundancy status for the specified DRG.
-
#get_drg_route_distribution(drg_route_distribution_id, opts = {}) ⇒ Response
Gets the specified route distribution's information.
-
#get_drg_route_table(drg_route_table_id, opts = {}) ⇒ Response
Gets the specified DRG route table's information.
-
#get_fast_connect_provider_service(provider_service_id, opts = {}) ⇒ Response
Gets the specified provider service.
-
#get_fast_connect_provider_service_key(provider_service_id, provider_service_key_name, opts = {}) ⇒ Response
Gets the specified provider service key's information.
-
#get_internet_gateway(ig_id, opts = {}) ⇒ Response
Gets the specified internet gateway's information.
-
#get_ip_sec_connection(ipsc_id, opts = {}) ⇒ Response
Gets the specified IPSec connection's basic information, including the static routes for the on-premises router.
-
#get_ip_sec_connection_device_config(ipsc_id, opts = {}) ⇒ Response
Deprecated.
-
#get_ip_sec_connection_device_status(ipsc_id, opts = {}) ⇒ Response
Deprecated.
-
#get_ip_sec_connection_tunnel(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Gets the specified tunnel's information.
-
#get_ip_sec_connection_tunnel_error(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Gets the identified error for the specified IPSec tunnel ID.
-
#get_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Gets the specified tunnel's shared secret (pre-shared key).
-
#get_ipsec_cpe_device_config_content(ipsc_id, opts = {}, &block) ⇒ Response
Renders a set of CPE configuration content for the specified IPSec connection (for all the tunnels in the connection).
-
#get_ipv6(ipv6_id, opts = {}) ⇒ Response
Gets the specified IPv6.
-
#get_local_peering_gateway(local_peering_gateway_id, opts = {}) ⇒ Response
Gets the specified local peering gateway's information.
-
#get_nat_gateway(nat_gateway_id, opts = {}) ⇒ Response
Gets the specified NAT gateway's information.
-
#get_network_security_group(network_security_group_id, opts = {}) ⇒ Response
Gets the specified network security group's information.
-
#get_networking_topology(compartment_id, opts = {}) ⇒ Response
Gets a virtual networking topology for the current region.
-
#get_private_ip(private_ip_id, opts = {}) ⇒ Response
Gets the specified private IP.
-
#get_public_ip(public_ip_id, opts = {}) ⇒ Response
Gets the specified public IP.
-
#get_public_ip_by_ip_address(get_public_ip_by_ip_address_details, opts = {}) ⇒ Response
Gets the public IP based on the public IP address (for example, 203.0.113.2).
-
#get_public_ip_by_private_ip_id(get_public_ip_by_private_ip_id_details, opts = {}) ⇒ Response
Gets the public IP assigned to the specified private IP.
-
#get_public_ip_pool(public_ip_pool_id, opts = {}) ⇒ Response
Gets the specified
PublicIpPool
object. -
#get_remote_peering_connection(remote_peering_connection_id, opts = {}) ⇒ Response
Get the specified remote peering connection's information.
-
#get_resource_ip_inventory(data_request_id, opts = {}) ⇒ Response
Gets the
IpInventory
resource. -
#get_route_table(rt_id, opts = {}) ⇒ Response
Gets the specified route table's information.
-
#get_security_list(security_list_id, opts = {}) ⇒ Response
Gets the specified security list's information.
-
#get_service(service_id, opts = {}) ⇒ Response
Gets the specified Service object.
-
#get_service_gateway(service_gateway_id, opts = {}) ⇒ Response
Gets the specified service gateway's information.
-
#get_subnet(subnet_id, opts = {}) ⇒ Response
Gets the specified subnet's information.
-
#get_subnet_cidr_utilization(subnet_id, opts = {}) ⇒ Response
Gets the CIDR utilization data of the specified subnet.
-
#get_subnet_ip_inventory(subnet_id, opts = {}) ⇒ Response
Gets the IP Inventory data of the specified subnet.
-
#get_subnet_topology(compartment_id, subnet_id, opts = {}) ⇒ Response
Gets a topology for a given subnet.
-
#get_tunnel_cpe_device_config(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Gets the set of CPE configuration answers for the tunnel, which the customer provided in update_tunnel_cpe_device_config.
-
#get_tunnel_cpe_device_config_content(ipsc_id, tunnel_id, opts = {}, &block) ⇒ Response
Renders a set of CPE configuration content for the specified IPSec tunnel.
-
#get_upgrade_status(drg_id, opts = {}) ⇒ Response
Returns the DRG upgrade status.
-
#get_vcn(vcn_id, opts = {}) ⇒ Response
Gets the specified VCN's information.
-
#get_vcn_dns_resolver_association(vcn_id, opts = {}) ⇒ Response
Get the associated DNS resolver information with a vcn.
-
#get_vcn_overlap(vcn_id, get_vcn_overlap_details, opts = {}) ⇒ Response
Gets the CIDR overlap information of the specified VCN in selected compartments.
-
#get_vcn_topology(compartment_id, vcn_id, opts = {}) ⇒ Response
Gets a virtual network topology for a given VCN.
-
#get_virtual_circuit(virtual_circuit_id, opts = {}) ⇒ Response
Gets the specified virtual circuit's information.
-
#get_vlan(vlan_id, opts = {}) ⇒ Response
Gets the specified VLAN's information.
-
#get_vnic(vnic_id, opts = {}) ⇒ Response
Gets the information for the specified virtual network interface card (VNIC).
-
#get_vtap(vtap_id, opts = {}) ⇒ Response
Gets the specified
Vtap
resource. -
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ VirtualNetworkClient
constructor
Creates a new VirtualNetworkClient.
-
#list_allowed_peer_regions_for_remote_peering(opts = {}) ⇒ Response
Lists the regions that support remote VCN peering (which is peering across regions).
-
#list_byoip_allocated_ranges(byoip_range_id, opts = {}) ⇒ Response
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.
-
#list_byoip_ranges(compartment_id, opts = {}) ⇒ Response
Lists the
ByoipRange
resources in the specified compartment. -
#list_capture_filters(compartment_id, opts = {}) ⇒ Response
Lists the capture filters in the specified compartment.
-
#list_cpe_device_shapes(opts = {}) ⇒ Response
Lists the CPE device types that the Networking service provides CPE configuration content for (example: Cisco ASA).
-
#list_cpes(compartment_id, opts = {}) ⇒ Response
Lists the customer-premises equipment objects (CPEs) in the specified compartment.
-
#list_cross_connect_groups(compartment_id, opts = {}) ⇒ Response
Lists the cross-connect groups in the specified compartment.
-
#list_cross_connect_locations(compartment_id, opts = {}) ⇒ Response
Lists the available FastConnect locations for cross-connect installation.
-
#list_cross_connect_mappings(virtual_circuit_id, opts = {}) ⇒ Response
Lists the Cross Connect mapping Details for the specified virtual circuit.
-
#list_cross_connects(compartment_id, opts = {}) ⇒ Response
Lists the cross-connects in the specified compartment.
-
#list_crossconnect_port_speed_shapes(compartment_id, opts = {}) ⇒ Response
Lists the available port speeds for cross-connects.
-
#list_dhcp_options(compartment_id, opts = {}) ⇒ Response
Lists the sets of DHCP options in the specified VCN and specified compartment.
-
#list_drg_attachments(compartment_id, opts = {}) ⇒ Response
Lists the
DrgAttachment
resource for the specified compartment. -
#list_drg_route_distribution_statements(drg_route_distribution_id, opts = {}) ⇒ Response
Lists the statements for the specified route distribution.
-
#list_drg_route_distributions(drg_id, opts = {}) ⇒ Response
Lists the route distributions in the specified DRG.
-
#list_drg_route_rules(drg_route_table_id, opts = {}) ⇒ Response
Lists the route rules in the specified DRG route table.
-
#list_drg_route_tables(drg_id, opts = {}) ⇒ Response
Lists the DRG route tables for the specified DRG.
-
#list_drgs(compartment_id, opts = {}) ⇒ Response
Lists the DRGs in the specified compartment.
-
#list_fast_connect_provider_services(compartment_id, opts = {}) ⇒ Response
Lists the service offerings from supported providers.
-
#list_fast_connect_provider_virtual_circuit_bandwidth_shapes(provider_service_id, opts = {}) ⇒ Response
Gets the list of available virtual circuit bandwidth levels for a provider.
-
#list_internet_gateways(compartment_id, opts = {}) ⇒ Response
Lists the internet gateways in the specified VCN and the specified compartment.
-
#list_ip_inventory(list_ip_inventory_details, opts = {}) ⇒ Response
Lists the IP Inventory information in the selected compartments.
-
#list_ip_sec_connection_tunnel_routes(ipsc_id, tunnel_id, opts = {}) ⇒ Response
The routes advertised to the on-premises network and the routes received from the on-premises network.
-
#list_ip_sec_connection_tunnel_security_associations(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Lists the tunnel security associations information for the specified IPSec tunnel ID.
-
#list_ip_sec_connection_tunnels(ipsc_id, opts = {}) ⇒ Response
Lists the tunnel information for the specified IPSec connection.
-
#list_ip_sec_connections(compartment_id, opts = {}) ⇒ Response
Lists the IPSec connections for the specified compartment.
-
#list_ipv6s(opts = {}) ⇒ Response
Lists the Ipv6 objects based on one of these filters:.
-
#list_local_peering_gateways(compartment_id, opts = {}) ⇒ Response
Lists the local peering gateways (LPGs) for the specified VCN and specified compartment.
-
#list_nat_gateways(compartment_id, opts = {}) ⇒ Response
Lists the NAT gateways in the specified compartment.
-
#list_network_security_group_security_rules(network_security_group_id, opts = {}) ⇒ Response
Lists the security rules in the specified network security group.
-
#list_network_security_group_vnics(network_security_group_id, opts = {}) ⇒ Response
Lists the VNICs in the specified network security group.
-
#list_network_security_groups(opts = {}) ⇒ Response
Lists either the network security groups in the specified compartment, or those associated with the specified VLAN.
-
#list_private_ips(opts = {}) ⇒ Response
Lists the PrivateIp objects based on one of these filters:.
-
#list_public_ip_pools(compartment_id, opts = {}) ⇒ Response
Lists the public IP pools in the specified compartment.
-
#list_public_ips(scope, compartment_id, opts = {}) ⇒ Response
Lists the PublicIp objects in the specified compartment.
-
#list_remote_peering_connections(compartment_id, opts = {}) ⇒ Response
Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC's compartment).
-
#list_route_tables(compartment_id, opts = {}) ⇒ Response
Lists the route tables in the specified VCN and specified compartment.
-
#list_security_lists(compartment_id, opts = {}) ⇒ Response
Lists the security lists in the specified VCN and compartment.
-
#list_service_gateways(compartment_id, opts = {}) ⇒ Response
Lists the service gateways in the specified compartment.
-
#list_services(opts = {}) ⇒ Response
Lists the available Service objects that you can enable for a service gateway in this region.
-
#list_subnets(compartment_id, opts = {}) ⇒ Response
Lists the subnets in the specified VCN and the specified compartment.
-
#list_vcns(compartment_id, opts = {}) ⇒ Response
Lists the virtual cloud networks (VCNs) in the specified compartment.
-
#list_virtual_circuit_associated_tunnels(virtual_circuit_id, opts = {}) ⇒ Response
Gets the specified virtual circuit's associatedTunnelsInfo.
-
#list_virtual_circuit_bandwidth_shapes(compartment_id, opts = {}) ⇒ Response
The deprecated operation lists available bandwidth levels for virtual circuits.
-
#list_virtual_circuit_public_prefixes(virtual_circuit_id, opts = {}) ⇒ Response
Lists the public IP prefixes and their details for the specified public virtual circuit.
-
#list_virtual_circuits(compartment_id, opts = {}) ⇒ Response
Lists the virtual circuits in the specified compartment.
-
#list_vlans(compartment_id, opts = {}) ⇒ Response
Lists the VLANs in the specified VCN and the specified compartment.
-
#list_vtaps(compartment_id, opts = {}) ⇒ Response
Lists the virtual test access points (VTAPs) in the specified compartment.
-
#logger ⇒ Logger
The logger for this client.
-
#modify_vcn_cidr(vcn_id, modify_vcn_cidr_details, opts = {}) ⇒ Response
Updates the specified CIDR block of a VCN.
-
#remove_drg_route_distribution_statements(drg_route_distribution_id, remove_drg_route_distribution_statements_details, opts = {}) ⇒ Response
Removes one or more route distribution statements from the specified route distribution's map.
-
#remove_drg_route_rules(drg_route_table_id, remove_drg_route_rules_details, opts = {}) ⇒ Response
Removes one or more route rules from the specified DRG route table.
-
#remove_export_drg_route_distribution(drg_attachment_id, opts = {}) ⇒ Response
Removes the export route distribution from the DRG attachment so no routes are advertised to it.
-
#remove_import_drg_route_distribution(drg_route_table_id, opts = {}) ⇒ Response
Removes the import route distribution from the DRG route table so no routes are imported into it.
-
#remove_ipv6_subnet_cidr(subnet_id, remove_subnet_ipv6_cidr_details, opts = {}) ⇒ Response
Remove an IPv6 prefix from a subnet.
-
#remove_ipv6_vcn_cidr(vcn_id, opts = {}) ⇒ Response
Removing an existing IPv6 prefix from a VCN.
-
#remove_network_security_group_security_rules(network_security_group_id, remove_network_security_group_security_rules_details, opts = {}) ⇒ Response
Removes one or more security rules from the specified network security group.
-
#remove_public_ip_pool_capacity(public_ip_pool_id, remove_public_ip_pool_capacity_details, opts = {}) ⇒ Response
Removes a CIDR block from the referenced public IP pool.
-
#remove_vcn_cidr(vcn_id, remove_vcn_cidr_details, opts = {}) ⇒ Response
Removes a specified CIDR block from a VCN.
-
#update_byoip_range(byoip_range_id, update_byoip_range_details, opts = {}) ⇒ Response
Updates the tags or display name associated to the specified BYOIP CIDR block.
-
#update_capture_filter(capture_filter_id, update_capture_filter_details, opts = {}) ⇒ Response
Updates the specified VTAP capture filter's display name or tags.
-
#update_cpe(cpe_id, update_cpe_details, opts = {}) ⇒ Response
Updates the specified CPE's display name or tags.
-
#update_cross_connect(cross_connect_id, update_cross_connect_details, opts = {}) ⇒ Response
Updates the specified cross-connect.
-
#update_cross_connect_group(cross_connect_group_id, update_cross_connect_group_details, opts = {}) ⇒ Response
Updates the specified cross-connect group's display name.
-
#update_dhcp_options(dhcp_id, update_dhcp_details, opts = {}) ⇒ Response
Updates the specified set of DHCP options.
-
#update_drg(drg_id, update_drg_details, opts = {}) ⇒ Response
Updates the specified DRG's display name or tags.
-
#update_drg_attachment(drg_attachment_id, update_drg_attachment_details, opts = {}) ⇒ Response
Updates the display name and routing information for the specified
DrgAttachment
. -
#update_drg_route_distribution(drg_route_distribution_id, update_drg_route_distribution_details, opts = {}) ⇒ Response
Updates the specified route distribution.
-
#update_drg_route_distribution_statements(drg_route_distribution_id, update_drg_route_distribution_statements_details, opts = {}) ⇒ Response
Updates one or more route distribution statements in the specified route distribution.
-
#update_drg_route_rules(drg_route_table_id, update_drg_route_rules_details, opts = {}) ⇒ Response
Updates one or more route rules in the specified DRG route table.
-
#update_drg_route_table(drg_route_table_id, update_drg_route_table_details, opts = {}) ⇒ Response
Updates the specified DRG route table.
-
#update_internet_gateway(ig_id, update_internet_gateway_details, opts = {}) ⇒ Response
Updates the specified internet gateway.
-
#update_ip_sec_connection(ipsc_id, update_ip_sec_connection_details, opts = {}) ⇒ Response
Updates the specified IPSec connection.
-
#update_ip_sec_connection_tunnel(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_details, opts = {}) ⇒ Response
Updates the specified tunnel.
-
#update_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_shared_secret_details, opts = {}) ⇒ Response
Updates the shared secret (pre-shared key) for the specified tunnel.
-
#update_ipv6(ipv6_id, update_ipv6_details, opts = {}) ⇒ Response
Updates the specified IPv6.
-
#update_local_peering_gateway(local_peering_gateway_id, update_local_peering_gateway_details, opts = {}) ⇒ Response
Updates the specified local peering gateway (LPG).
-
#update_nat_gateway(nat_gateway_id, update_nat_gateway_details, opts = {}) ⇒ Response
Updates the specified NAT gateway.
-
#update_network_security_group(network_security_group_id, update_network_security_group_details, opts = {}) ⇒ Response
Updates the specified network security group.
-
#update_network_security_group_security_rules(network_security_group_id, update_network_security_group_security_rules_details, opts = {}) ⇒ Response
Updates one or more security rules in the specified network security group.
-
#update_private_ip(private_ip_id, update_private_ip_details, opts = {}) ⇒ Response
Updates the specified private IP.
-
#update_public_ip(public_ip_id, update_public_ip_details, opts = {}) ⇒ Response
Updates the specified public IP.
-
#update_public_ip_pool(public_ip_pool_id, update_public_ip_pool_details, opts = {}) ⇒ Response
Updates the specified public IP pool.
-
#update_remote_peering_connection(remote_peering_connection_id, update_remote_peering_connection_details, opts = {}) ⇒ Response
Updates the specified remote peering connection (RPC).
-
#update_route_table(rt_id, update_route_table_details, opts = {}) ⇒ Response
Updates the specified route table's display name or route rules.
-
#update_security_list(security_list_id, update_security_list_details, opts = {}) ⇒ Response
Updates the specified security list's display name or rules.
-
#update_service_gateway(service_gateway_id, update_service_gateway_details, opts = {}) ⇒ Response
Updates the specified service gateway.
-
#update_subnet(subnet_id, update_subnet_details, opts = {}) ⇒ Response
Updates the specified subnet.
-
#update_tunnel_cpe_device_config(ipsc_id, tunnel_id, update_tunnel_cpe_device_config_details, opts = {}) ⇒ Response
Creates or updates the set of CPE configuration answers for the specified tunnel.
-
#update_vcn(vcn_id, update_vcn_details, opts = {}) ⇒ Response
Updates the specified VCN.
-
#update_virtual_circuit(virtual_circuit_id, update_virtual_circuit_details, opts = {}) ⇒ Response
Updates the specified virtual circuit.
-
#update_vlan(vlan_id, update_vlan_details, opts = {}) ⇒ Response
Updates the specified VLAN.
-
#update_vnic(vnic_id, update_vnic_details, opts = {}) ⇒ Response
Updates the specified VNIC.
-
#update_vtap(vtap_id, update_vtap_details, opts = {}) ⇒ Response
Updates the specified VTAP's display name or tags.
-
#upgrade_drg(drg_id, opts = {}) ⇒ Response
Upgrades the DRG.
-
#validate_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Submits the BYOIP CIDR block you are importing for validation.
-
#withdraw_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Withdraws BGP route advertisement for the BYOIP CIDR block.
Constructor Details
#initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) ⇒ VirtualNetworkClient
Creates a new VirtualNetworkClient. Notes: If a config is not specified, then the global OCI.config will be used.
This client is not thread-safe
Either a region or an endpoint must be specified. If an endpoint is specified, it will be used instead of the region. A region may be specified in the config or via or the region parameter. If specified in both, then the region parameter will be used.
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/oci/core/virtual_network_client.rb', line 61 def initialize(config: nil, region: nil, endpoint: nil, signer: nil, proxy_settings: nil, retry_config: nil) # If the signer is an InstancePrincipalsSecurityTokenSigner or SecurityTokenSigner and no config was supplied (they are self-sufficient signers) # then create a dummy config to pass to the ApiClient constructor. If customers wish to create a client which uses instance principals # and has config (either populated programmatically or loaded from a file), they must construct that config themselves and then # pass it to this constructor. # # If there is no signer (or the signer is not an instance principals signer) and no config was supplied, this is not valid # so try and load the config from the default file. config = OCI::Config.validate_and_build_config_with_signer(config, signer) signer = OCI::Signer.config_file_auth_builder(config) if signer.nil? @api_client = OCI::ApiClient.new(config, signer, proxy_settings: proxy_settings) @retry_config = retry_config if endpoint @endpoint = endpoint + '/20160918' else region ||= config.region region ||= signer.region if signer.respond_to?(:region) self.region = region end logger.info "VirtualNetworkClient endpoint set to '#{@endpoint}'." if logger end |
Instance Attribute Details
#api_client ⇒ OCI::ApiClient (readonly)
Client used to make HTTP requests.
21 22 23 |
# File 'lib/oci/core/virtual_network_client.rb', line 21 def api_client @api_client end |
#endpoint ⇒ String (readonly)
Fully qualified endpoint URL
25 26 27 |
# File 'lib/oci/core/virtual_network_client.rb', line 25 def endpoint @endpoint end |
#region ⇒ String
The region, which will usually correspond to a value in Regions::REGION_ENUM.
35 36 37 |
# File 'lib/oci/core/virtual_network_client.rb', line 35 def region @region end |
#retry_config ⇒ OCI::Retry::RetryConfig (readonly)
The default retry configuration to apply to all operations in this service client. This can be overridden on a per-operation basis. The default retry configuration value is nil
, which means that an operation will not perform any retries
31 32 33 |
# File 'lib/oci/core/virtual_network_client.rb', line 31 def retry_config @retry_config end |
Instance Method Details
#add_drg_route_distribution_statements(drg_route_distribution_id, add_drg_route_distribution_statements_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_drg_route_distribution_statements API.
Adds one or more route distribution statements to the specified route distribution.
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/oci/core/virtual_network_client.rb', line 119 def add_drg_route_distribution_statements(drg_route_distribution_id, add_drg_route_distribution_statements_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#add_drg_route_distribution_statements.' if logger raise "Missing the required parameter 'drg_route_distribution_id' when calling add_drg_route_distribution_statements." if drg_route_distribution_id.nil? raise "Missing the required parameter 'add_drg_route_distribution_statements_details' when calling add_drg_route_distribution_statements." if add_drg_route_distribution_statements_details.nil? raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id) path = '/drgRouteDistributions/{drgRouteDistributionId}/actions/addDrgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(add_drg_route_distribution_statements_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_drg_route_distribution_statements') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteDistributionStatement>' ) end # rubocop:enable Metrics/BlockLength end |
#add_drg_route_rules(drg_route_table_id, add_drg_route_rules_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_drg_route_rules API.
Adds one or more static route rules to the specified DRG route table.
181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
# File 'lib/oci/core/virtual_network_client.rb', line 181 def add_drg_route_rules(drg_route_table_id, add_drg_route_rules_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#add_drg_route_rules.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling add_drg_route_rules." if drg_route_table_id.nil? raise "Missing the required parameter 'add_drg_route_rules_details' when calling add_drg_route_rules." if add_drg_route_rules_details.nil? raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}/actions/addDrgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(add_drg_route_rules_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_drg_route_rules') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteRule>' ) end # rubocop:enable Metrics/BlockLength end |
#add_ipv6_subnet_cidr(subnet_id, add_subnet_ipv6_cidr_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_ipv6_subnet_cidr API.
Add an IPv6 prefix to a subnet.
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
# File 'lib/oci/core/virtual_network_client.rb', line 251 def add_ipv6_subnet_cidr(subnet_id, add_subnet_ipv6_cidr_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#add_ipv6_subnet_cidr.' if logger raise "Missing the required parameter 'subnet_id' when calling add_ipv6_subnet_cidr." if subnet_id.nil? raise "Missing the required parameter 'add_subnet_ipv6_cidr_details' when calling add_ipv6_subnet_cidr." if add_subnet_ipv6_cidr_details.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/subnets/{subnetId}/actions/addIpv6Cidr'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(add_subnet_ipv6_cidr_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_ipv6_subnet_cidr') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#add_ipv6_vcn_cidr(vcn_id, opts = {}) ⇒ Response
Click here to see an example of how to use add_ipv6_vcn_cidr API.
Add an IPv6 prefix to a VCN. The VCN size is always /56 and assigned by Oracle. Once added the IPv6 prefix cannot be removed or modified.
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 |
# File 'lib/oci/core/virtual_network_client.rb', line 324 def add_ipv6_vcn_cidr(vcn_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#add_ipv6_vcn_cidr.' if logger raise "Missing the required parameter 'vcn_id' when calling add_ipv6_vcn_cidr." if vcn_id.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}/actions/addIpv6Cidr'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(opts[:add_vcn_ipv6_cidr_details]) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_ipv6_vcn_cidr') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#add_network_security_group_security_rules(network_security_group_id, add_network_security_group_security_rules_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_network_security_group_security_rules API.
Adds one or more security rules to the specified network security group.
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 |
# File 'lib/oci/core/virtual_network_client.rb', line 382 def add_network_security_group_security_rules(network_security_group_id, add_network_security_group_security_rules_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#add_network_security_group_security_rules.' if logger raise "Missing the required parameter 'network_security_group_id' when calling add_network_security_group_security_rules." if network_security_group_id.nil? raise "Missing the required parameter 'add_network_security_group_security_rules_details' when calling add_network_security_group_security_rules." if add_network_security_group_security_rules_details.nil? raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/addSecurityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(add_network_security_group_security_rules_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_network_security_group_security_rules') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::AddedNetworkSecurityGroupSecurityRules' ) end # rubocop:enable Metrics/BlockLength end |
#add_public_ip_pool_capacity(public_ip_pool_id, add_public_ip_pool_capacity_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_public_ip_pool_capacity API.
Adds some or all of a CIDR block to a public IP pool.
The CIDR block (or subrange) must not overlap with any other CIDR block already added to this or any other public IP pool.
449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 |
# File 'lib/oci/core/virtual_network_client.rb', line 449 def add_public_ip_pool_capacity(public_ip_pool_id, add_public_ip_pool_capacity_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#add_public_ip_pool_capacity.' if logger raise "Missing the required parameter 'public_ip_pool_id' when calling add_public_ip_pool_capacity." if public_ip_pool_id.nil? raise "Missing the required parameter 'add_public_ip_pool_capacity_details' when calling add_public_ip_pool_capacity." if add_public_ip_pool_capacity_details.nil? raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id) path = '/publicIpPools/{publicIpPoolId}/actions/addCapacity'.sub('{publicIpPoolId}', public_ip_pool_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(add_public_ip_pool_capacity_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_public_ip_pool_capacity') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIpPool' ) end # rubocop:enable Metrics/BlockLength end |
#add_vcn_cidr(vcn_id, add_vcn_cidr_details, opts = {}) ⇒ Response
Click here to see an example of how to use add_vcn_cidr API.
Adds a CIDR block to a VCN. The CIDR block you add:
-
Must be valid.
-
Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.
-
Must not exceed the limit of CIDR blocks allowed per VCN.
Note: Adding a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the GetWorkRequest
operation to check the status of the update.
526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 |
# File 'lib/oci/core/virtual_network_client.rb', line 526 def add_vcn_cidr(vcn_id, add_vcn_cidr_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#add_vcn_cidr.' if logger raise "Missing the required parameter 'vcn_id' when calling add_vcn_cidr." if vcn_id.nil? raise "Missing the required parameter 'add_vcn_cidr_details' when calling add_vcn_cidr." if add_vcn_cidr_details.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}/actions/addCidr'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(add_vcn_cidr_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#add_vcn_cidr') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#advertise_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Click here to see an example of how to use advertise_byoip_range API.
Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud. The ByoipRange
resource must be in the PROVISIONED state before the BYOIP CIDR block routes can be advertised with BGP.
587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 |
# File 'lib/oci/core/virtual_network_client.rb', line 587 def advertise_byoip_range(byoip_range_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#advertise_byoip_range.' if logger raise "Missing the required parameter 'byoip_range_id' when calling advertise_byoip_range." if byoip_range_id.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}/actions/advertise'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#advertise_byoip_range') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#attach_service_id(service_gateway_id, attach_service_details, opts = {}) ⇒ Response
Click here to see an example of how to use attach_service_id API.
Adds the specified Service to the list of enabled Service
objects for the specified gateway. You must also set up a route rule with the cidrBlock
of the Service
as the rule's destination and the service gateway as the rule's target. See RouteTable.
Note: The AttachServiceId
operation is an easy way to add an individual Service
to the service gateway. Compare it with update_service_gateway, which replaces the entire existing list of enabled Service
objects with the list that you provide in the Update
call.
654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 |
# File 'lib/oci/core/virtual_network_client.rb', line 654 def attach_service_id(service_gateway_id, attach_service_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#attach_service_id.' if logger raise "Missing the required parameter 'service_gateway_id' when calling attach_service_id." if service_gateway_id.nil? raise "Missing the required parameter 'attach_service_details' when calling attach_service_id." if attach_service_details.nil? raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id) path = '/serviceGateways/{serviceGatewayId}/actions/attachService'.sub('{serviceGatewayId}', service_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(attach_service_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#attach_service_id') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ServiceGateway' ) end # rubocop:enable Metrics/BlockLength end |
#bulk_add_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_add_virtual_circuit_public_prefixes_details, opts = {}) ⇒ Response
Click here to see an example of how to use bulk_add_virtual_circuit_public_prefixes API.
Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not update_virtual_circuit) to add prefixes to the virtual circuit. Oracle must verify the customer's ownership of each prefix before traffic for that prefix will flow across the virtual circuit.
714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 |
# File 'lib/oci/core/virtual_network_client.rb', line 714 def bulk_add_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_add_virtual_circuit_public_prefixes_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#bulk_add_virtual_circuit_public_prefixes.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling bulk_add_virtual_circuit_public_prefixes." if virtual_circuit_id.nil? raise "Missing the required parameter 'bulk_add_virtual_circuit_public_prefixes_details' when calling bulk_add_virtual_circuit_public_prefixes." if bulk_add_virtual_circuit_public_prefixes_details.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}/actions/bulkAddPublicPrefixes'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(bulk_add_virtual_circuit_public_prefixes_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_add_virtual_circuit_public_prefixes') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#bulk_delete_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_delete_virtual_circuit_public_prefixes_details, opts = {}) ⇒ Response
Click here to see an example of how to use bulk_delete_virtual_circuit_public_prefixes API.
Removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not update_virtual_circuit) to remove prefixes from the virtual circuit. When the virtual circuit's state switches back to PROVISIONED, Oracle stops advertising the specified prefixes across the connection.
773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 |
# File 'lib/oci/core/virtual_network_client.rb', line 773 def bulk_delete_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_delete_virtual_circuit_public_prefixes_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#bulk_delete_virtual_circuit_public_prefixes.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling bulk_delete_virtual_circuit_public_prefixes." if virtual_circuit_id.nil? raise "Missing the required parameter 'bulk_delete_virtual_circuit_public_prefixes_details' when calling bulk_delete_virtual_circuit_public_prefixes." if bulk_delete_virtual_circuit_public_prefixes_details.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}/actions/bulkDeletePublicPrefixes'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(bulk_delete_virtual_circuit_public_prefixes_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#bulk_delete_virtual_circuit_public_prefixes') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_byoip_range_compartment(byoip_range_id, change_byoip_range_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_byoip_range_compartment API.
Moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 |
# File 'lib/oci/core/virtual_network_client.rb', line 839 def change_byoip_range_compartment(byoip_range_id, change_byoip_range_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_byoip_range_compartment.' if logger raise "Missing the required parameter 'byoip_range_id' when calling change_byoip_range_compartment." if byoip_range_id.nil? raise "Missing the required parameter 'change_byoip_range_compartment_details' when calling change_byoip_range_compartment." if change_byoip_range_compartment_details.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}/actions/changeCompartment'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_byoip_range_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_byoip_range_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_capture_filter_compartment(capture_filter_id, change_capture_filter_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_capture_filter_compartment API.
Moves a capture filter to a new compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 |
# File 'lib/oci/core/virtual_network_client.rb', line 911 def change_capture_filter_compartment(capture_filter_id, change_capture_filter_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_capture_filter_compartment.' if logger raise "Missing the required parameter 'capture_filter_id' when calling change_capture_filter_compartment." if capture_filter_id.nil? raise "Missing the required parameter 'change_capture_filter_compartment_details' when calling change_capture_filter_compartment." if change_capture_filter_compartment_details.nil? raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id) path = '/captureFilters/{captureFilterId}/actions/changeCompartment'.sub('{captureFilterId}', capture_filter_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_capture_filter_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_capture_filter_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_cpe_compartment(cpe_id, change_cpe_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_cpe_compartment API.
Moves a CPE object into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 |
# File 'lib/oci/core/virtual_network_client.rb', line 980 def change_cpe_compartment(cpe_id, change_cpe_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_cpe_compartment.' if logger raise "Missing the required parameter 'cpe_id' when calling change_cpe_compartment." if cpe_id.nil? raise "Missing the required parameter 'change_cpe_compartment_details' when calling change_cpe_compartment." if change_cpe_compartment_details.nil? raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id) path = '/cpes/{cpeId}/actions/changeCompartment'.sub('{cpeId}', cpe_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_cpe_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_cpe_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_cross_connect_compartment(cross_connect_id, change_cross_connect_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_cross_connect_compartment API.
Moves a cross-connect into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 |
# File 'lib/oci/core/virtual_network_client.rb', line 1048 def change_cross_connect_compartment(cross_connect_id, change_cross_connect_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_cross_connect_compartment.' if logger raise "Missing the required parameter 'cross_connect_id' when calling change_cross_connect_compartment." if cross_connect_id.nil? raise "Missing the required parameter 'change_cross_connect_compartment_details' when calling change_cross_connect_compartment." if change_cross_connect_compartment_details.nil? raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id) path = '/crossConnects/{crossConnectId}/actions/changeCompartment'.sub('{crossConnectId}', cross_connect_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_cross_connect_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_cross_connect_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_cross_connect_group_compartment(cross_connect_group_id, change_cross_connect_group_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_cross_connect_group_compartment API.
Moves a cross-connect group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 |
# File 'lib/oci/core/virtual_network_client.rb', line 1116 def change_cross_connect_group_compartment(cross_connect_group_id, change_cross_connect_group_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_cross_connect_group_compartment.' if logger raise "Missing the required parameter 'cross_connect_group_id' when calling change_cross_connect_group_compartment." if cross_connect_group_id.nil? raise "Missing the required parameter 'change_cross_connect_group_compartment_details' when calling change_cross_connect_group_compartment." if change_cross_connect_group_compartment_details.nil? raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id) path = '/crossConnectGroups/{crossConnectGroupId}/actions/changeCompartment'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_cross_connect_group_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_cross_connect_group_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_dhcp_options_compartment(dhcp_id, change_dhcp_options_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_dhcp_options_compartment API.
Moves a set of DHCP options into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 |
# File 'lib/oci/core/virtual_network_client.rb', line 1184 def (dhcp_id, , opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_dhcp_options_compartment.' if logger raise "Missing the required parameter 'dhcp_id' when calling change_dhcp_options_compartment." if dhcp_id.nil? raise "Missing the required parameter 'change_dhcp_options_compartment_details' when calling change_dhcp_options_compartment." if .nil? raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id) path = '/dhcps/{dhcpId}/actions/changeCompartment'.sub('{dhcpId}', dhcp_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_dhcp_options_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_drg_compartment(drg_id, change_drg_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_drg_compartment API.
Moves a DRG into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 |
# File 'lib/oci/core/virtual_network_client.rb', line 1252 def change_drg_compartment(drg_id, change_drg_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_drg_compartment.' if logger raise "Missing the required parameter 'drg_id' when calling change_drg_compartment." if drg_id.nil? raise "Missing the required parameter 'change_drg_compartment_details' when calling change_drg_compartment." if change_drg_compartment_details.nil? raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}/actions/changeCompartment'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_drg_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_drg_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_internet_gateway_compartment(ig_id, change_internet_gateway_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_internet_gateway_compartment API.
Moves an internet gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 |
# File 'lib/oci/core/virtual_network_client.rb', line 1320 def change_internet_gateway_compartment(ig_id, change_internet_gateway_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_internet_gateway_compartment.' if logger raise "Missing the required parameter 'ig_id' when calling change_internet_gateway_compartment." if ig_id.nil? raise "Missing the required parameter 'change_internet_gateway_compartment_details' when calling change_internet_gateway_compartment." if change_internet_gateway_compartment_details.nil? raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id) path = '/internetGateways/{igId}/actions/changeCompartment'.sub('{igId}', ig_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_internet_gateway_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_internet_gateway_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_ip_sec_connection_compartment(ipsc_id, change_ip_sec_connection_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_ip_sec_connection_compartment API.
Moves an IPSec connection into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 |
# File 'lib/oci/core/virtual_network_client.rb', line 1388 def change_ip_sec_connection_compartment(ipsc_id, change_ip_sec_connection_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_ip_sec_connection_compartment.' if logger raise "Missing the required parameter 'ipsc_id' when calling change_ip_sec_connection_compartment." if ipsc_id.nil? raise "Missing the required parameter 'change_ip_sec_connection_compartment_details' when calling change_ip_sec_connection_compartment." if change_ip_sec_connection_compartment_details.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}/actions/changeCompartment'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_ip_sec_connection_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_ip_sec_connection_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_local_peering_gateway_compartment(local_peering_gateway_id, change_local_peering_gateway_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_local_peering_gateway_compartment API.
Moves a local peering gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 |
# File 'lib/oci/core/virtual_network_client.rb', line 1456 def change_local_peering_gateway_compartment(local_peering_gateway_id, change_local_peering_gateway_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_local_peering_gateway_compartment.' if logger raise "Missing the required parameter 'local_peering_gateway_id' when calling change_local_peering_gateway_compartment." if local_peering_gateway_id.nil? raise "Missing the required parameter 'change_local_peering_gateway_compartment_details' when calling change_local_peering_gateway_compartment." if change_local_peering_gateway_compartment_details.nil? raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id) path = '/localPeeringGateways/{localPeeringGatewayId}/actions/changeCompartment'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_local_peering_gateway_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_local_peering_gateway_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_nat_gateway_compartment(nat_gateway_id, change_nat_gateway_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_nat_gateway_compartment API.
Moves a NAT gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 |
# File 'lib/oci/core/virtual_network_client.rb', line 1524 def change_nat_gateway_compartment(nat_gateway_id, change_nat_gateway_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_nat_gateway_compartment.' if logger raise "Missing the required parameter 'nat_gateway_id' when calling change_nat_gateway_compartment." if nat_gateway_id.nil? raise "Missing the required parameter 'change_nat_gateway_compartment_details' when calling change_nat_gateway_compartment." if change_nat_gateway_compartment_details.nil? raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id) path = '/natGateways/{natGatewayId}/actions/changeCompartment'.sub('{natGatewayId}', nat_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_nat_gateway_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_nat_gateway_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_network_security_group_compartment(network_security_group_id, change_network_security_group_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_network_security_group_compartment API.
Moves a network security group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 |
# File 'lib/oci/core/virtual_network_client.rb', line 1591 def change_network_security_group_compartment(network_security_group_id, change_network_security_group_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_network_security_group_compartment.' if logger raise "Missing the required parameter 'network_security_group_id' when calling change_network_security_group_compartment." if network_security_group_id.nil? raise "Missing the required parameter 'change_network_security_group_compartment_details' when calling change_network_security_group_compartment." if change_network_security_group_compartment_details.nil? raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/changeCompartment'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_network_security_group_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_network_security_group_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_public_ip_compartment(public_ip_id, change_public_ip_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_public_ip_compartment API.
Moves a public IP into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
This operation applies only to reserved public IPs. Ephemeral public IPs always belong to the same compartment as their VNIC and move accordingly.
1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 |
# File 'lib/oci/core/virtual_network_client.rb', line 1662 def change_public_ip_compartment(public_ip_id, change_public_ip_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_public_ip_compartment.' if logger raise "Missing the required parameter 'public_ip_id' when calling change_public_ip_compartment." if public_ip_id.nil? raise "Missing the required parameter 'change_public_ip_compartment_details' when calling change_public_ip_compartment." if change_public_ip_compartment_details.nil? raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id) path = '/publicIps/{publicIpId}/actions/changeCompartment'.sub('{publicIpId}', public_ip_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_public_ip_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_public_ip_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_public_ip_pool_compartment(public_ip_pool_id, change_public_ip_pool_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_public_ip_pool_compartment API.
Moves a public IP pool to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 |
# File 'lib/oci/core/virtual_network_client.rb', line 1730 def change_public_ip_pool_compartment(public_ip_pool_id, change_public_ip_pool_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_public_ip_pool_compartment.' if logger raise "Missing the required parameter 'public_ip_pool_id' when calling change_public_ip_pool_compartment." if public_ip_pool_id.nil? raise "Missing the required parameter 'change_public_ip_pool_compartment_details' when calling change_public_ip_pool_compartment." if change_public_ip_pool_compartment_details.nil? raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id) path = '/publicIpPools/{publicIpPoolId}/actions/changeCompartment'.sub('{publicIpPoolId}', public_ip_pool_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_public_ip_pool_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_public_ip_pool_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_remote_peering_connection_compartment(remote_peering_connection_id, change_remote_peering_connection_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_remote_peering_connection_compartment API.
Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 |
# File 'lib/oci/core/virtual_network_client.rb', line 1798 def change_remote_peering_connection_compartment(remote_peering_connection_id, change_remote_peering_connection_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_remote_peering_connection_compartment.' if logger raise "Missing the required parameter 'remote_peering_connection_id' when calling change_remote_peering_connection_compartment." if remote_peering_connection_id.nil? raise "Missing the required parameter 'change_remote_peering_connection_compartment_details' when calling change_remote_peering_connection_compartment." if change_remote_peering_connection_compartment_details.nil? raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id) path = '/remotePeeringConnections/{remotePeeringConnectionId}/actions/changeCompartment'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_remote_peering_connection_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_remote_peering_connection_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_route_table_compartment(rt_id, change_route_table_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_route_table_compartment API.
Moves a route table into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 |
# File 'lib/oci/core/virtual_network_client.rb', line 1866 def change_route_table_compartment(rt_id, change_route_table_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_route_table_compartment.' if logger raise "Missing the required parameter 'rt_id' when calling change_route_table_compartment." if rt_id.nil? raise "Missing the required parameter 'change_route_table_compartment_details' when calling change_route_table_compartment." if change_route_table_compartment_details.nil? raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id) path = '/routeTables/{rtId}/actions/changeCompartment'.sub('{rtId}', rt_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_route_table_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_route_table_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_security_list_compartment(security_list_id, change_security_list_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_security_list_compartment API.
Moves a security list into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 |
# File 'lib/oci/core/virtual_network_client.rb', line 1934 def change_security_list_compartment(security_list_id, change_security_list_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_security_list_compartment.' if logger raise "Missing the required parameter 'security_list_id' when calling change_security_list_compartment." if security_list_id.nil? raise "Missing the required parameter 'change_security_list_compartment_details' when calling change_security_list_compartment." if change_security_list_compartment_details.nil? raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id) path = '/securityLists/{securityListId}/actions/changeCompartment'.sub('{securityListId}', security_list_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_security_list_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_security_list_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_service_gateway_compartment(service_gateway_id, change_service_gateway_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_service_gateway_compartment API.
Moves a service gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 |
# File 'lib/oci/core/virtual_network_client.rb', line 2002 def change_service_gateway_compartment(service_gateway_id, change_service_gateway_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_service_gateway_compartment.' if logger raise "Missing the required parameter 'service_gateway_id' when calling change_service_gateway_compartment." if service_gateway_id.nil? raise "Missing the required parameter 'change_service_gateway_compartment_details' when calling change_service_gateway_compartment." if change_service_gateway_compartment_details.nil? raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id) path = '/serviceGateways/{serviceGatewayId}/actions/changeCompartment'.sub('{serviceGatewayId}', service_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_service_gateway_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_service_gateway_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_subnet_compartment(subnet_id, change_subnet_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_subnet_compartment API.
Moves a subnet into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 |
# File 'lib/oci/core/virtual_network_client.rb', line 2070 def change_subnet_compartment(subnet_id, change_subnet_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_subnet_compartment.' if logger raise "Missing the required parameter 'subnet_id' when calling change_subnet_compartment." if subnet_id.nil? raise "Missing the required parameter 'change_subnet_compartment_details' when calling change_subnet_compartment." if change_subnet_compartment_details.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/subnets/{subnetId}/actions/changeCompartment'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_subnet_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_subnet_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_vcn_compartment(vcn_id, change_vcn_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_vcn_compartment API.
Moves a VCN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 |
# File 'lib/oci/core/virtual_network_client.rb', line 2138 def change_vcn_compartment(vcn_id, change_vcn_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_vcn_compartment.' if logger raise "Missing the required parameter 'vcn_id' when calling change_vcn_compartment." if vcn_id.nil? raise "Missing the required parameter 'change_vcn_compartment_details' when calling change_vcn_compartment." if change_vcn_compartment_details.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}/actions/changeCompartment'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_vcn_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_vcn_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_virtual_circuit_compartment(virtual_circuit_id, change_virtual_circuit_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_virtual_circuit_compartment API.
Moves a virtual circuit into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 |
# File 'lib/oci/core/virtual_network_client.rb', line 2206 def change_virtual_circuit_compartment(virtual_circuit_id, change_virtual_circuit_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_virtual_circuit_compartment.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling change_virtual_circuit_compartment." if virtual_circuit_id.nil? raise "Missing the required parameter 'change_virtual_circuit_compartment_details' when calling change_virtual_circuit_compartment." if change_virtual_circuit_compartment_details.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}/actions/changeCompartment'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_virtual_circuit_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_virtual_circuit_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_vlan_compartment(vlan_id, change_vlan_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_vlan_compartment API.
Moves a VLAN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 |
# File 'lib/oci/core/virtual_network_client.rb', line 2278 def change_vlan_compartment(vlan_id, change_vlan_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_vlan_compartment.' if logger raise "Missing the required parameter 'vlan_id' when calling change_vlan_compartment." if vlan_id.nil? raise "Missing the required parameter 'change_vlan_compartment_details' when calling change_vlan_compartment." if change_vlan_compartment_details.nil? raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id) path = '/vlans/{vlanId}/actions/changeCompartment'.sub('{vlanId}', vlan_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_vlan_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_vlan_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#change_vtap_compartment(vtap_id, change_vtap_compartment_details, opts = {}) ⇒ Response
Click here to see an example of how to use change_vtap_compartment API.
Moves a VTAP to a new compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 |
# File 'lib/oci/core/virtual_network_client.rb', line 2351 def change_vtap_compartment(vtap_id, change_vtap_compartment_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#change_vtap_compartment.' if logger raise "Missing the required parameter 'vtap_id' when calling change_vtap_compartment." if vtap_id.nil? raise "Missing the required parameter 'change_vtap_compartment_details' when calling change_vtap_compartment." if change_vtap_compartment_details.nil? raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id) path = '/vtaps/{vtapId}/actions/changeCompartment'.sub('{vtapId}', vtap_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(change_vtap_compartment_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#change_vtap_compartment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#connect_local_peering_gateways(local_peering_gateway_id, connect_local_peering_gateways_details, opts = {}) ⇒ Response
Click here to see an example of how to use connect_local_peering_gateways API.
Connects this local peering gateway (LPG) to another one in the same region.
This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to LPGs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 |
# File 'lib/oci/core/virtual_network_client.rb', line 2417 def connect_local_peering_gateways(local_peering_gateway_id, connect_local_peering_gateways_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#connect_local_peering_gateways.' if logger raise "Missing the required parameter 'local_peering_gateway_id' when calling connect_local_peering_gateways." if local_peering_gateway_id.nil? raise "Missing the required parameter 'connect_local_peering_gateways_details' when calling connect_local_peering_gateways." if connect_local_peering_gateways_details.nil? raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id) path = '/localPeeringGateways/{localPeeringGatewayId}/actions/connect'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(connect_local_peering_gateways_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#connect_local_peering_gateways') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#connect_remote_peering_connections(remote_peering_connection_id, connect_remote_peering_connections_details, opts = {}) ⇒ Response
Click here to see an example of how to use connect_remote_peering_connections API.
Connects this RPC to another one in a different region.
This operation must be called by the VCN administrator who is designated as the requestor in the peering relationship. The acceptor must implement an Identity and Access Management (IAM) policy that gives the requestor permission to connect to RPCs in the acceptor's compartment. Without that permission, this operation will fail. For more information, see VCN Peering.
2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 |
# File 'lib/oci/core/virtual_network_client.rb', line 2481 def connect_remote_peering_connections(remote_peering_connection_id, connect_remote_peering_connections_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#connect_remote_peering_connections.' if logger raise "Missing the required parameter 'remote_peering_connection_id' when calling connect_remote_peering_connections." if remote_peering_connection_id.nil? raise "Missing the required parameter 'connect_remote_peering_connections_details' when calling connect_remote_peering_connections." if connect_remote_peering_connections_details.nil? raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id) path = '/remotePeeringConnections/{remotePeeringConnectionId}/actions/connect'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(connect_remote_peering_connections_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#connect_remote_peering_connections') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#create_byoip_range(create_byoip_range_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_byoip_range API.
Creates a subrange of the BYOIP CIDR block.
2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 |
# File 'lib/oci/core/virtual_network_client.rb', line 2544 def create_byoip_range(create_byoip_range_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_byoip_range.' if logger raise "Missing the required parameter 'create_byoip_range_details' when calling create_byoip_range." if create_byoip_range_details.nil? path = '/byoipRanges' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_byoip_range_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_byoip_range') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ByoipRange' ) end # rubocop:enable Metrics/BlockLength end |
#create_capture_filter(create_capture_filter_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_capture_filter API.
Creates a virtual test access point (VTAP) capture filter in the specified compartment.
For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.
2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 |
# File 'lib/oci/core/virtual_network_client.rb', line 2616 def create_capture_filter(create_capture_filter_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_capture_filter.' if logger raise "Missing the required parameter 'create_capture_filter_details' when calling create_capture_filter." if create_capture_filter_details.nil? path = '/captureFilters' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_capture_filter_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_capture_filter') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CaptureFilter' ) end # rubocop:enable Metrics/BlockLength end |
#create_cpe(create_cpe_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_cpe API.
Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see Site-to-Site VPN Overview.
For the purposes of access control, you must provide the OCID of the compartment where you want the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec connection or other Networking Service components. If you're not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You must provide the public IP address of your on-premises router. See CPE Configuration.
You may optionally specify a display name for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 |
# File 'lib/oci/core/virtual_network_client.rb', line 2691 def create_cpe(create_cpe_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_cpe.' if logger raise "Missing the required parameter 'create_cpe_details' when calling create_cpe." if create_cpe_details.nil? path = '/cpes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_cpe_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_cpe') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Cpe' ) end # rubocop:enable Metrics/BlockLength end |
#create_cross_connect(create_cross_connect_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_cross_connect API.
Creates a new cross-connect. Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection.
After creating the CrossConnect
object, you need to go the FastConnect location and request to have the physical cable installed. For more information, see FastConnect Overview.
For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect to reside. If you're not sure which compartment to use, put the cross-connect in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the cross-connect. It does not have to be unique, and you can change it. Avoid entering confidential information.
2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 |
# File 'lib/oci/core/virtual_network_client.rb', line 2769 def create_cross_connect(create_cross_connect_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_cross_connect.' if logger raise "Missing the required parameter 'create_cross_connect_details' when calling create_cross_connect." if create_cross_connect_details.nil? path = '/crossConnects' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_cross_connect_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_cross_connect') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnect' ) end # rubocop:enable Metrics/BlockLength end |
#create_cross_connect_group(create_cross_connect_group_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_cross_connect_group API.
Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview.
For the purposes of access control, you must provide the OCID of the compartment where you want the cross-connect group to reside. If you're not sure which compartment to use, put the cross-connect group in the same compartment with your VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the cross-connect group. It does not have to be unique, and you can change it. Avoid entering confidential information.
2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 |
# File 'lib/oci/core/virtual_network_client.rb', line 2843 def create_cross_connect_group(create_cross_connect_group_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_cross_connect_group.' if logger raise "Missing the required parameter 'create_cross_connect_group_details' when calling create_cross_connect_group." if create_cross_connect_group_details.nil? path = '/crossConnectGroups' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_cross_connect_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_cross_connect_group') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnectGroup' ) end # rubocop:enable Metrics/BlockLength end |
#create_dhcp_options(create_dhcp_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_dhcp_options API.
Creates a new set of DHCP options for the specified VCN. For more information, see DhcpOptions.
For the purposes of access control, you must provide the OCID of the compartment where you want the set of DHCP options to reside. Notice that the set of options doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the set of DHCP options in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the set of DHCP options, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 |
# File 'lib/oci/core/virtual_network_client.rb', line 2914 def (create_dhcp_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_dhcp_options.' if logger raise "Missing the required parameter 'create_dhcp_details' when calling create_dhcp_options." if create_dhcp_details.nil? path = '/dhcps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_dhcp_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_dhcp_options') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DhcpOptions' ) end # rubocop:enable Metrics/BlockLength end |
#create_drg(create_drg_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_drg API.
Creates a new dynamic routing gateway (DRG) in the specified compartment. For more information, see Dynamic Routing Gateways (DRGs).
For the purposes of access control, you must provide the OCID of the compartment where you want the DRG to reside. Notice that the DRG doesn't have to be in the same compartment as the VCN, the DRG attachment, or other Networking Service components. If you're not sure which compartment to use, put the DRG in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the DRG, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 |
# File 'lib/oci/core/virtual_network_client.rb', line 2985 def create_drg(create_drg_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_drg.' if logger raise "Missing the required parameter 'create_drg_details' when calling create_drg." if create_drg_details.nil? path = '/drgs' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_drg_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Drg' ) end # rubocop:enable Metrics/BlockLength end |
#create_drg_attachment(create_drg_attachment_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_drg_attachment API.
Attaches the specified DRG to the specified network resource. A VCN can be attached to only one DRG at a time, but a DRG can be attached to more than one VCN. The response includes a DrgAttachment
object with its own OCID. For more information about DRGs, see Dynamic Routing Gateways (DRGs).
You may optionally specify a display name for the attachment, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
For the purposes of access control, the DRG attachment is automatically placed into the currently selected compartment. For more information about compartments and access control, see Overview of the IAM Service.
3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 |
# File 'lib/oci/core/virtual_network_client.rb', line 3055 def (, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_drg_attachment.' if logger raise "Missing the required parameter 'create_drg_attachment_details' when calling create_drg_attachment." if .nil? path = '/drgAttachments' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg_attachment') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#create_drg_route_distribution(create_drg_route_distribution_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_drg_route_distribution API.
Creates a new route distribution for the specified DRG. Assign the route distribution as an import distribution to a DRG route table using the UpdateDrgRouteTable
or CreateDrgRouteTable
operations. Assign the route distribution as an export distribution to a DRG attachment using the UpdateDrgAttachment
or CreateDrgAttachment
operations.
3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 |
# File 'lib/oci/core/virtual_network_client.rb', line 3118 def create_drg_route_distribution(create_drg_route_distribution_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_drg_route_distribution.' if logger raise "Missing the required parameter 'create_drg_route_distribution_details' when calling create_drg_route_distribution." if create_drg_route_distribution_details.nil? path = '/drgRouteDistributions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_drg_route_distribution_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg_route_distribution') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRouteDistribution' ) end # rubocop:enable Metrics/BlockLength end |
#create_drg_route_table(create_drg_route_table_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_drg_route_table API.
Creates a new DRG route table for the specified DRG. Assign the DRG route table to a DRG attachment using the UpdateDrgAttachment
or CreateDrgAttachment
operations.
3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 |
# File 'lib/oci/core/virtual_network_client.rb', line 3179 def create_drg_route_table(create_drg_route_table_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_drg_route_table.' if logger raise "Missing the required parameter 'create_drg_route_table_details' when calling create_drg_route_table." if create_drg_route_table_details.nil? path = '/drgRouteTables' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_drg_route_table_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_drg_route_table') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRouteTable' ) end # rubocop:enable Metrics/BlockLength end |
#create_internet_gateway(create_internet_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_internet_gateway API.
Creates a new internet gateway for the specified VCN. For more information, see Access to the Internet.
For the purposes of access control, you must provide the OCID of the compartment where you want the Internet Gateway to reside. Notice that the internet gateway doesn't have to be in the same compartment as the VCN or other Networking Service components. If you're not sure which compartment to use, put the Internet Gateway in the same compartment with the VCN. For more information about compartments and access control, see Overview of the IAM Service.
You may optionally specify a display name for the internet gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
For traffic to flow between a subnet and an internet gateway, you must create a route rule accordingly in the subnet's route table (for example, 0.0.0.0/0 > internet gateway). See update_route_table.
You must specify whether the internet gateway is enabled when you create it. If it's disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic. You can later use update_internet_gateway to easily disable/enable the gateway without changing the route rule.
3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 |
# File 'lib/oci/core/virtual_network_client.rb', line 3258 def create_internet_gateway(create_internet_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_internet_gateway.' if logger raise "Missing the required parameter 'create_internet_gateway_details' when calling create_internet_gateway." if create_internet_gateway_details.nil? path = '/internetGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_internet_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_internet_gateway') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::InternetGateway' ) end # rubocop:enable Metrics/BlockLength end |
#create_ip_sec_connection(create_ip_sec_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_ip_sec_connection API.
Creates a new IPSec connection between the specified DRG and CPE. For more information, see Site-to-Site VPN Overview.
If you configure at least one tunnel to use static routing, then in the request you must provide at least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. For more information, see the important note in IPSecConnection.
For the purposes of access control, you must provide the OCID of the compartment where you want the IPSec connection to reside. Notice that the IPSec connection doesn't have to be in the same compartment as the DRG, CPE, or other Networking Service components. If you're not sure which compartment to use, put the IPSec connection in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service.
You may optionally specify a display name for the IPSec connection, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
After creating the IPSec connection, you need to configure your on-premises router with tunnel-specific information. For tunnel status and the required configuration information, see:
-
IPSecConnectionTunnel
-
IPSecConnectionTunnelSharedSecret
For each tunnel, you need the IP address of Oracle's VPN headend and the shared secret (that is, the pre-shared key). For more information, see CPE Configuration.
3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 |
# File 'lib/oci/core/virtual_network_client.rb', line 3345 def create_ip_sec_connection(create_ip_sec_connection_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_ip_sec_connection.' if logger raise "Missing the required parameter 'create_ip_sec_connection_details' when calling create_ip_sec_connection." if create_ip_sec_connection_details.nil? path = '/ipsecConnections' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_ip_sec_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_ip_sec_connection') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnection' ) end # rubocop:enable Metrics/BlockLength end |
#create_ipv6(create_ipv6_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_ipv6 API.
Creates an IPv6 for the specified VNIC.
3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 |
# File 'lib/oci/core/virtual_network_client.rb', line 3408 def create_ipv6(create_ipv6_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_ipv6.' if logger raise "Missing the required parameter 'create_ipv6_details' when calling create_ipv6." if create_ipv6_details.nil? path = '/ipv6' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_ipv6_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_ipv6') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Ipv6' ) end # rubocop:enable Metrics/BlockLength end |
#create_local_peering_gateway(create_local_peering_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_local_peering_gateway API.
Creates a new local peering gateway (LPG) for the specified VCN.
3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 |
# File 'lib/oci/core/virtual_network_client.rb', line 3469 def create_local_peering_gateway(create_local_peering_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_local_peering_gateway.' if logger raise "Missing the required parameter 'create_local_peering_gateway_details' when calling create_local_peering_gateway." if create_local_peering_gateway_details.nil? path = '/localPeeringGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_local_peering_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_local_peering_gateway') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::LocalPeeringGateway' ) end # rubocop:enable Metrics/BlockLength end |
#create_nat_gateway(create_nat_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_nat_gateway API.
Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule's target. See RouteTable.
3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 |
# File 'lib/oci/core/virtual_network_client.rb', line 3530 def create_nat_gateway(create_nat_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_nat_gateway.' if logger raise "Missing the required parameter 'create_nat_gateway_details' when calling create_nat_gateway." if create_nat_gateway_details.nil? path = '/natGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_nat_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_nat_gateway') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::NatGateway' ) end # rubocop:enable Metrics/BlockLength end |
#create_network_security_group(create_network_security_group_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_network_security_group API.
Creates a new network security group for the specified VCN.
3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 |
# File 'lib/oci/core/virtual_network_client.rb', line 3590 def create_network_security_group(create_network_security_group_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_network_security_group.' if logger raise "Missing the required parameter 'create_network_security_group_details' when calling create_network_security_group." if create_network_security_group_details.nil? path = '/networkSecurityGroups' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_network_security_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_network_security_group') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::NetworkSecurityGroup' ) end # rubocop:enable Metrics/BlockLength end |
#create_private_ip(create_private_ip_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_private_ip API.
Creates a secondary private IP for the specified VNIC. For more information about secondary private IPs, see IP Addresses.
3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 |
# File 'lib/oci/core/virtual_network_client.rb', line 3652 def create_private_ip(create_private_ip_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_private_ip.' if logger raise "Missing the required parameter 'create_private_ip_details' when calling create_private_ip." if create_private_ip_details.nil? path = '/privateIps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_private_ip_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_private_ip') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PrivateIp' ) end # rubocop:enable Metrics/BlockLength end |
#create_public_ip(create_public_ip_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_public_ip API.
Creates a public IP. Use the lifetime
property to specify whether it's an ephemeral or reserved public IP. For information about limits on how many you can create, see Public IP Addresses.
-
For an ephemeral public IP assigned to a private IP: You must also specify a
privateIpId
with the OCID of the primary private IP you want to assign the public IP to. The public IP is created in the same availability domain as the private IP. An ephemeral public IP must always be assigned to a private IP, and only to the primary private IP on a VNIC, not a secondary private IP. Exception: If you create a NatGateway, Oracle automatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove. -
For a reserved public IP: You may also optionally assign the public IP to a private IP by specifying
privateIpId
. Or you can later assign the public IP with update_public_ip.
Note: When assigning a public IP to a private IP, the private IP must not already have a public IP with lifecycleState
= ASSIGNING or ASSIGNED. If it does, an error is returned.
Also, for reserved public IPs, the optional assignment part of this operation is asynchronous. Poll the public IP's lifecycleState
to determine if the assignment succeeded.
3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 |
# File 'lib/oci/core/virtual_network_client.rb', line 3732 def create_public_ip(create_public_ip_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_public_ip.' if logger raise "Missing the required parameter 'create_public_ip_details' when calling create_public_ip." if create_public_ip_details.nil? path = '/publicIps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_public_ip_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_public_ip') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIp' ) end # rubocop:enable Metrics/BlockLength end |
#create_public_ip_pool(create_public_ip_pool_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_public_ip_pool API.
Creates a public IP pool.
3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 |
# File 'lib/oci/core/virtual_network_client.rb', line 3795 def create_public_ip_pool(create_public_ip_pool_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_public_ip_pool.' if logger raise "Missing the required parameter 'create_public_ip_pool_details' when calling create_public_ip_pool." if create_public_ip_pool_details.nil? path = '/publicIpPools' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_public_ip_pool_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_public_ip_pool') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIpPool' ) end # rubocop:enable Metrics/BlockLength end |
#create_remote_peering_connection(create_remote_peering_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_remote_peering_connection API.
Creates a new remote peering connection (RPC) for the specified DRG.
3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 |
# File 'lib/oci/core/virtual_network_client.rb', line 3856 def create_remote_peering_connection(create_remote_peering_connection_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_remote_peering_connection.' if logger raise "Missing the required parameter 'create_remote_peering_connection_details' when calling create_remote_peering_connection." if create_remote_peering_connection_details.nil? path = '/remotePeeringConnections' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_remote_peering_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_remote_peering_connection') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::RemotePeeringConnection' ) end # rubocop:enable Metrics/BlockLength end |
#create_route_table(create_route_table_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_route_table API.
Creates a new route table for the specified VCN. In the request you must also include at least one route rule for the new route table. For information on the number of rules you can have in a route table, see Service Limits. For general information about route tables in your VCN and the types of targets you can use in route rules, see Route Tables.
For the purposes of access control, you must provide the OCID of the compartment where you want the route table to reside. Notice that the route table doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the route table in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the route table, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 |
# File 'lib/oci/core/virtual_network_client.rb', line 3930 def create_route_table(create_route_table_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_route_table.' if logger raise "Missing the required parameter 'create_route_table_details' when calling create_route_table." if create_route_table_details.nil? path = '/routeTables' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_route_table_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_route_table') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::RouteTable' ) end # rubocop:enable Metrics/BlockLength end |
#create_security_list(create_security_list_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_security_list API.
Creates a new security list for the specified VCN. For more information about security lists, see Security Lists. For information on the number of rules you can have in a security list, see Service Limits.
For the purposes of access control, you must provide the OCID of the compartment where you want the security list to reside. Notice that the security list doesn't have to be in the same compartment as the VCN, subnets, or other Networking Service components. If you're not sure which compartment to use, put the security list in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the security list, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 |
# File 'lib/oci/core/virtual_network_client.rb', line 4003 def create_security_list(create_security_list_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_security_list.' if logger raise "Missing the required parameter 'create_security_list_details' when calling create_security_list." if create_security_list_details.nil? path = '/securityLists' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_security_list_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_security_list') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::SecurityList' ) end # rubocop:enable Metrics/BlockLength end |
#create_service_gateway(create_service_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_service_gateway API.
Creates a new service gateway in the specified compartment.
For the purposes of access control, you must provide the OCID of the compartment where you want the service gateway to reside. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the service gateway, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 |
# File 'lib/oci/core/virtual_network_client.rb', line 4071 def create_service_gateway(create_service_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_service_gateway.' if logger raise "Missing the required parameter 'create_service_gateway_details' when calling create_service_gateway." if create_service_gateway_details.nil? path = '/serviceGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_service_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_service_gateway') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ServiceGateway' ) end # rubocop:enable Metrics/BlockLength end |
#create_subnet(create_subnet_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_subnet API.
Creates a new subnet in the specified VCN. You can't change the size of the subnet after creation, so it's important to think about the size of subnets you need before creating them. For more information, see VCNs and Subnets. For information on the number of subnets you can have in a VCN, see Service Limits.
For the purposes of access control, you must provide the OCID of the compartment where you want the subnet to reside. Notice that the subnet doesn't have to be in the same compartment as the VCN, route tables, or other Networking Service components. If you're not sure which compartment to use, put the subnet in the same compartment as the VCN. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally associate a route table with the subnet. If you don't, the subnet will use the VCN's default route table. For more information about route tables, see Route Tables.
You may optionally associate a security list with the subnet. If you don't, the subnet will use the VCN's default security list. For more information about security lists, see Security Lists.
You may optionally associate a set of DHCP options with the subnet. If you don't, the subnet will use the VCN's default set. For more information about DHCP options, see DHCP Options.
You may optionally specify a display name for the subnet, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
You can also add a DNS label for the subnet, which is required if you want the Internet and VCN Resolver to resolve hostnames for instances in the subnet. For more information, see DNS in Your Virtual Cloud Network.
4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 |
# File 'lib/oci/core/virtual_network_client.rb', line 4161 def create_subnet(create_subnet_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_subnet.' if logger raise "Missing the required parameter 'create_subnet_details' when calling create_subnet." if create_subnet_details.nil? path = '/subnets' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_subnet_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_subnet') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Subnet' ) end # rubocop:enable Metrics/BlockLength end |
#create_vcn(create_vcn_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_vcn API.
Creates a new virtual cloud network (VCN). For more information, see VCNs and Subnets.
For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria:
-
The CIDR blocks must be valid.
-
They must not overlap with each other or with the on-premises network CIDR block.
-
The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN.
For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in RFC 1918 (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR blocks can range from /16 to /30.
For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the VCN, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.
You can also add a DNS label for the VCN, which is required if you want the instances to use the Interent and VCN Resolver option for DNS in the VCN. For more information, see DNS in Your Virtual Cloud Network.
The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The OCID for each is returned in the response. You can't delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on).
The VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN or FastConnect. For more information, see Overview of the Networking Service.
4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 |
# File 'lib/oci/core/virtual_network_client.rb', line 4253 def create_vcn(create_vcn_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_vcn.' if logger raise "Missing the required parameter 'create_vcn_details' when calling create_vcn." if create_vcn_details.nil? path = '/vcns' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_vcn_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_vcn') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vcn' ) end # rubocop:enable Metrics/BlockLength end |
#create_virtual_circuit(create_virtual_circuit_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_virtual_circuit API.
Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect. For more information, see FastConnect Overview.
For the purposes of access control, you must provide the OCID of the compartment where you want the virtual circuit to reside. If you're not sure which compartment to use, put the virtual circuit in the same compartment with the DRG it's using. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the virtual circuit. It does not have to be unique, and you can change it. Avoid entering confidential information.
Important: When creating a virtual circuit, you specify a DRG for the traffic to flow through. Make sure you attach the DRG to your VCN and confirm the VCN's routing sends traffic to the DRG. Otherwise traffic will not flow. For more information, see Route Tables.
4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 |
# File 'lib/oci/core/virtual_network_client.rb', line 4333 def create_virtual_circuit(create_virtual_circuit_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_virtual_circuit.' if logger raise "Missing the required parameter 'create_virtual_circuit_details' when calling create_virtual_circuit." if create_virtual_circuit_details.nil? path = '/virtualCircuits' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_virtual_circuit_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_virtual_circuit') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VirtualCircuit' ) end # rubocop:enable Metrics/BlockLength end |
#create_vlan(create_vlan_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_vlan API.
Creates a VLAN in the specified VCN and the specified compartment.
4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 |
# File 'lib/oci/core/virtual_network_client.rb', line 4396 def create_vlan(create_vlan_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_vlan.' if logger raise "Missing the required parameter 'create_vlan_details' when calling create_vlan." if create_vlan_details.nil? path = '/vlans' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_vlan_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_vlan') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vlan' ) end # rubocop:enable Metrics/BlockLength end |
#create_vtap(create_vtap_details, opts = {}) ⇒ Response
Click here to see an example of how to use create_vtap API.
Creates a virtual test access point (VTAP) in the specified compartment.
For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers.
You may optionally specify a display name for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.
4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 |
# File 'lib/oci/core/virtual_network_client.rb', line 4468 def create_vtap(create_vtap_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#create_vtap.' if logger raise "Missing the required parameter 'create_vtap_details' when calling create_vtap." if create_vtap_details.nil? path = '/vtaps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(create_vtap_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#create_vtap') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vtap' ) end # rubocop:enable Metrics/BlockLength end |
#delete_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_byoip_range API.
Deletes the specified ByoipRange
resource. The resource must be in one of the following states: CREATING, PROVISIONED, ACTIVE, or FAILED. It must not have any subranges currently allocated to a PublicIpPool object or the deletion will fail. You must specify the OCID. If the ByoipRange
resource is currently in the PROVISIONED or ACTIVE state, it will be de-provisioned and then deleted.
4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 |
# File 'lib/oci/core/virtual_network_client.rb', line 4534 def delete_byoip_range(byoip_range_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_byoip_range.' if logger raise "Missing the required parameter 'byoip_range_id' when calling delete_byoip_range." if byoip_range_id.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_byoip_range') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_capture_filter(capture_filter_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_capture_filter API.
Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's lifecycleState
will change to TERMINATING temporarily until the VTAP capture filter is completely removed.
4596 4597 4598 4599 4600 4601 4602 4603 4604 4605 4606 4607 4608 4609 4610 4611 4612 4613 4614 4615 4616 4617 4618 4619 4620 4621 4622 4623 4624 4625 4626 4627 4628 4629 4630 4631 4632 |
# File 'lib/oci/core/virtual_network_client.rb', line 4596 def delete_capture_filter(capture_filter_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_capture_filter.' if logger raise "Missing the required parameter 'capture_filter_id' when calling delete_capture_filter." if capture_filter_id.nil? raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id) path = '/captureFilters/{captureFilterId}'.sub('{captureFilterId}', capture_filter_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_capture_filter') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_cpe(cpe_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_cpe API.
Deletes the specified CPE object. The CPE must not be connected to a DRG. This is an asynchronous operation. The CPE's lifecycleState
will change to TERMINATING temporarily until the CPE is completely removed.
4656 4657 4658 4659 4660 4661 4662 4663 4664 4665 4666 4667 4668 4669 4670 4671 4672 4673 4674 4675 4676 4677 4678 4679 4680 4681 4682 4683 4684 4685 4686 4687 4688 4689 4690 4691 |
# File 'lib/oci/core/virtual_network_client.rb', line 4656 def delete_cpe(cpe_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_cpe.' if logger raise "Missing the required parameter 'cpe_id' when calling delete_cpe." if cpe_id.nil? raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id) path = '/cpes/{cpeId}'.sub('{cpeId}', cpe_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_cpe') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_cross_connect(cross_connect_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_cross_connect API.
Deletes the specified cross-connect. It must not be mapped to a VirtualCircuit.
4714 4715 4716 4717 4718 4719 4720 4721 4722 4723 4724 4725 4726 4727 4728 4729 4730 4731 4732 4733 4734 4735 4736 4737 4738 4739 4740 4741 4742 4743 4744 4745 4746 4747 4748 4749 |
# File 'lib/oci/core/virtual_network_client.rb', line 4714 def delete_cross_connect(cross_connect_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_cross_connect.' if logger raise "Missing the required parameter 'cross_connect_id' when calling delete_cross_connect." if cross_connect_id.nil? raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id) path = '/crossConnects/{crossConnectId}'.sub('{crossConnectId}', cross_connect_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_cross_connect') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_cross_connect_group(cross_connect_group_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_cross_connect_group API.
Deletes the specified cross-connect group. It must not contain any cross-connects, and it cannot be mapped to a VirtualCircuit.
4773 4774 4775 4776 4777 4778 4779 4780 4781 4782 4783 4784 4785 4786 4787 4788 4789 4790 4791 4792 4793 4794 4795 4796 4797 4798 4799 4800 4801 4802 4803 4804 4805 4806 4807 4808 |
# File 'lib/oci/core/virtual_network_client.rb', line 4773 def delete_cross_connect_group(cross_connect_group_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_cross_connect_group.' if logger raise "Missing the required parameter 'cross_connect_group_id' when calling delete_cross_connect_group." if cross_connect_group_id.nil? raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id) path = '/crossConnectGroups/{crossConnectGroupId}'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_cross_connect_group') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_dhcp_options(dhcp_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_dhcp_options API.
Deletes the specified set of DHCP options, but only if it's not associated with a subnet. You can't delete a VCN's default set of DHCP options.
This is an asynchronous operation. The state of the set of options will switch to TERMINATING temporarily until the set is completely removed.
4834 4835 4836 4837 4838 4839 4840 4841 4842 4843 4844 4845 4846 4847 4848 4849 4850 4851 4852 4853 4854 4855 4856 4857 4858 4859 4860 4861 4862 4863 4864 4865 4866 4867 4868 4869 |
# File 'lib/oci/core/virtual_network_client.rb', line 4834 def (dhcp_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_dhcp_options.' if logger raise "Missing the required parameter 'dhcp_id' when calling delete_dhcp_options." if dhcp_id.nil? raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id) path = '/dhcps/{dhcpId}'.sub('{dhcpId}', dhcp_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_dhcp_options') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_drg(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_drg API.
Deletes the specified DRG. The DRG must not be attached to a VCN or be connected to your on-premise network. Also, there must not be a route table that lists the DRG as a target. This is an asynchronous operation. The DRG's lifecycleState
will change to TERMINATING temporarily until the DRG is completely removed.
4894 4895 4896 4897 4898 4899 4900 4901 4902 4903 4904 4905 4906 4907 4908 4909 4910 4911 4912 4913 4914 4915 4916 4917 4918 4919 4920 4921 4922 4923 4924 4925 4926 4927 4928 4929 |
# File 'lib/oci/core/virtual_network_client.rb', line 4894 def delete_drg(drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_drg.' if logger raise "Missing the required parameter 'drg_id' when calling delete_drg." if drg_id.nil? raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_drg_attachment(drg_attachment_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_drg_attachment API.
Detaches a DRG from a network resource by deleting the corresponding DrgAttachment
resource. This is an asynchronous operation. The attachment's lifecycleState
will temporarily change to DETACHING until the attachment is completely removed.
4953 4954 4955 4956 4957 4958 4959 4960 4961 4962 4963 4964 4965 4966 4967 4968 4969 4970 4971 4972 4973 4974 4975 4976 4977 4978 4979 4980 4981 4982 4983 4984 4985 4986 4987 4988 |
# File 'lib/oci/core/virtual_network_client.rb', line 4953 def (, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_drg_attachment.' if logger raise "Missing the required parameter 'drg_attachment_id' when calling delete_drg_attachment." if .nil? raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/drgAttachments/{drgAttachmentId}'.sub('{drgAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg_attachment') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_drg_route_distribution(drg_route_distribution_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_drg_route_distribution API.
Deletes the specified route distribution. You can't delete a route distribution currently in use by a DRG attachment or DRG route table.
Remove the DRG route distribution from a DRG attachment or DRG route table by using the "RemoveExportDrgRouteDistribution" or "RemoveImportDrgRouteDistribution' operations.
5012 5013 5014 5015 5016 5017 5018 5019 5020 5021 5022 5023 5024 5025 5026 5027 5028 5029 5030 5031 5032 5033 5034 5035 5036 5037 5038 5039 5040 5041 5042 5043 5044 5045 5046 5047 |
# File 'lib/oci/core/virtual_network_client.rb', line 5012 def delete_drg_route_distribution(drg_route_distribution_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_drg_route_distribution.' if logger raise "Missing the required parameter 'drg_route_distribution_id' when calling delete_drg_route_distribution." if drg_route_distribution_id.nil? raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id) path = '/drgRouteDistributions/{drgRouteDistributionId}'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg_route_distribution') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_drg_route_table(drg_route_table_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_drg_route_table API.
Deletes the specified DRG route table. There must not be any DRG attachments assigned.
5069 5070 5071 5072 5073 5074 5075 5076 5077 5078 5079 5080 5081 5082 5083 5084 5085 5086 5087 5088 5089 5090 5091 5092 5093 5094 5095 5096 5097 5098 5099 5100 5101 5102 5103 5104 |
# File 'lib/oci/core/virtual_network_client.rb', line 5069 def delete_drg_route_table(drg_route_table_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_drg_route_table.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling delete_drg_route_table." if drg_route_table_id.nil? raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_drg_route_table') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_internet_gateway(ig_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_internet_gateway API.
Deletes the specified internet gateway. The internet gateway does not have to be disabled, but there must not be a route table that lists it as a target.
This is an asynchronous operation. The gateway's lifecycleState
will change to TERMINATING temporarily until the gateway is completely removed.
5130 5131 5132 5133 5134 5135 5136 5137 5138 5139 5140 5141 5142 5143 5144 5145 5146 5147 5148 5149 5150 5151 5152 5153 5154 5155 5156 5157 5158 5159 5160 5161 5162 5163 5164 5165 |
# File 'lib/oci/core/virtual_network_client.rb', line 5130 def delete_internet_gateway(ig_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_internet_gateway.' if logger raise "Missing the required parameter 'ig_id' when calling delete_internet_gateway." if ig_id.nil? raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id) path = '/internetGateways/{igId}'.sub('{igId}', ig_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_internet_gateway') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_ip_sec_connection(ipsc_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_ip_sec_connection API.
Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and on-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact. If you were to delete all the components and then later need to create an Site-to-Site VPN again, you would need to configure your on-premises router again with the new information returned from create_ip_sec_connection.
This is an asynchronous operation. The connection's lifecycleState
will change to TERMINATING temporarily until the connection is completely removed.
5194 5195 5196 5197 5198 5199 5200 5201 5202 5203 5204 5205 5206 5207 5208 5209 5210 5211 5212 5213 5214 5215 5216 5217 5218 5219 5220 5221 5222 5223 5224 5225 5226 5227 5228 5229 |
# File 'lib/oci/core/virtual_network_client.rb', line 5194 def delete_ip_sec_connection(ipsc_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_ip_sec_connection.' if logger raise "Missing the required parameter 'ipsc_id' when calling delete_ip_sec_connection." if ipsc_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_ip_sec_connection') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_ipv6(ipv6_id, opts = {}) ⇒ Response
5255 5256 5257 5258 5259 5260 5261 5262 5263 5264 5265 5266 5267 5268 5269 5270 5271 5272 5273 5274 5275 5276 5277 5278 5279 5280 5281 5282 5283 5284 5285 5286 5287 5288 5289 5290 5291 |
# File 'lib/oci/core/virtual_network_client.rb', line 5255 def delete_ipv6(ipv6_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_ipv6.' if logger raise "Missing the required parameter 'ipv6_id' when calling delete_ipv6." if ipv6_id.nil? raise "Parameter value for 'ipv6_id' must not be blank" if OCI::Internal::Util.blank_string?(ipv6_id) path = '/ipv6/{ipv6Id}'.sub('{ipv6Id}', ipv6_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_ipv6') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_local_peering_gateway(local_peering_gateway_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_local_peering_gateway API.
Deletes the specified local peering gateway (LPG).
This is an asynchronous operation; the local peering gateway's lifecycleState
changes to TERMINATING temporarily until the local peering gateway is completely removed.
5316 5317 5318 5319 5320 5321 5322 5323 5324 5325 5326 5327 5328 5329 5330 5331 5332 5333 5334 5335 5336 5337 5338 5339 5340 5341 5342 5343 5344 5345 5346 5347 5348 5349 5350 5351 |
# File 'lib/oci/core/virtual_network_client.rb', line 5316 def delete_local_peering_gateway(local_peering_gateway_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_local_peering_gateway.' if logger raise "Missing the required parameter 'local_peering_gateway_id' when calling delete_local_peering_gateway." if local_peering_gateway_id.nil? raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id) path = '/localPeeringGateways/{localPeeringGatewayId}'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_local_peering_gateway') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_nat_gateway(nat_gateway_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_nat_gateway API.
Deletes the specified NAT gateway. The NAT gateway does not have to be disabled, but there must not be a route rule that lists the NAT gateway as a target.
This is an asynchronous operation. The NAT gateway's lifecycleState
will change to TERMINATING temporarily until the NAT gateway is completely removed.
5377 5378 5379 5380 5381 5382 5383 5384 5385 5386 5387 5388 5389 5390 5391 5392 5393 5394 5395 5396 5397 5398 5399 5400 5401 5402 5403 5404 5405 5406 5407 5408 5409 5410 5411 5412 |
# File 'lib/oci/core/virtual_network_client.rb', line 5377 def delete_nat_gateway(nat_gateway_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_nat_gateway.' if logger raise "Missing the required parameter 'nat_gateway_id' when calling delete_nat_gateway." if nat_gateway_id.nil? raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id) path = '/natGateways/{natGatewayId}'.sub('{natGatewayId}', nat_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_nat_gateway') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_network_security_group(network_security_group_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_network_security_group API.
Deletes the specified network security group. The group must not contain any VNICs.
To get a list of the VNICs in a network security group, use #list_network_security_group_vnics list_network_security_group_vnics}. Each returned NetworkSecurityGroupVnic object contains both the {OCID of the VNIC and the OCID of the VNIC's parent resource (for example, the Compute instance that the VNIC is attached to).
5440 5441 5442 5443 5444 5445 5446 5447 5448 5449 5450 5451 5452 5453 5454 5455 5456 5457 5458 5459 5460 5461 5462 5463 5464 5465 5466 5467 5468 5469 5470 5471 5472 5473 5474 5475 |
# File 'lib/oci/core/virtual_network_client.rb', line 5440 def delete_network_security_group(network_security_group_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_network_security_group.' if logger raise "Missing the required parameter 'network_security_group_id' when calling delete_network_security_group." if network_security_group_id.nil? raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_network_security_group') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_private_ip(private_ip_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_private_ip API.
Unassigns and deletes the specified private IP. You must specify the object's OCID. The private IP address is returned to the subnet's pool of available addresses.
This operation cannot be used with primary private IPs, which are automatically unassigned and deleted when the VNIC is terminated.
Important: If a secondary private IP is the target of a route rule, unassigning it from the VNIC causes that route rule to blackhole and the traffic will be dropped.
5507 5508 5509 5510 5511 5512 5513 5514 5515 5516 5517 5518 5519 5520 5521 5522 5523 5524 5525 5526 5527 5528 5529 5530 5531 5532 5533 5534 5535 5536 5537 5538 5539 5540 5541 5542 |
# File 'lib/oci/core/virtual_network_client.rb', line 5507 def delete_private_ip(private_ip_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_private_ip.' if logger raise "Missing the required parameter 'private_ip_id' when calling delete_private_ip." if private_ip_id.nil? raise "Parameter value for 'private_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(private_ip_id) path = '/privateIps/{privateIpId}'.sub('{privateIpId}', private_ip_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_private_ip') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_public_ip(public_ip_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_public_ip API.
Unassigns and deletes the specified public IP (either ephemeral or reserved). You must specify the object's OCID. The public IP address is returned to the Oracle Cloud Infrastructure public IP pool.
Note: You cannot update, unassign, or delete the public IP that Oracle automatically assigned to an entity for you (such as a load balancer or NAT gateway). The public IP is automatically deleted if the assigned entity is terminated.
For an assigned reserved public IP, the initial unassignment portion of this operation is asynchronous. Poll the public IP's lifecycleState
to determine if the operation succeeded.
If you want to simply unassign a reserved public IP and return it to your pool of reserved public IPs, instead use update_public_ip.
5578 5579 5580 5581 5582 5583 5584 5585 5586 5587 5588 5589 5590 5591 5592 5593 5594 5595 5596 5597 5598 5599 5600 5601 5602 5603 5604 5605 5606 5607 5608 5609 5610 5611 5612 5613 |
# File 'lib/oci/core/virtual_network_client.rb', line 5578 def delete_public_ip(public_ip_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_public_ip.' if logger raise "Missing the required parameter 'public_ip_id' when calling delete_public_ip." if public_ip_id.nil? raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id) path = '/publicIps/{publicIpId}'.sub('{publicIpId}', public_ip_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_public_ip') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_public_ip_pool(public_ip_pool_id, opts = {}) ⇒ Response
5640 5641 5642 5643 5644 5645 5646 5647 5648 5649 5650 5651 5652 5653 5654 5655 5656 5657 5658 5659 5660 5661 5662 5663 5664 5665 5666 5667 5668 5669 5670 5671 5672 5673 5674 5675 5676 |
# File 'lib/oci/core/virtual_network_client.rb', line 5640 def delete_public_ip_pool(public_ip_pool_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_public_ip_pool.' if logger raise "Missing the required parameter 'public_ip_pool_id' when calling delete_public_ip_pool." if public_ip_pool_id.nil? raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id) path = '/publicIpPools/{publicIpPoolId}'.sub('{publicIpPoolId}', public_ip_pool_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_public_ip_pool') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_remote_peering_connection(remote_peering_connection_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_remote_peering_connection API.
Deletes the remote peering connection (RPC).
This is an asynchronous operation; the RPC's lifecycleState
changes to TERMINATING temporarily until the RPC is completely removed.
5701 5702 5703 5704 5705 5706 5707 5708 5709 5710 5711 5712 5713 5714 5715 5716 5717 5718 5719 5720 5721 5722 5723 5724 5725 5726 5727 5728 5729 5730 5731 5732 5733 5734 5735 5736 |
# File 'lib/oci/core/virtual_network_client.rb', line 5701 def delete_remote_peering_connection(remote_peering_connection_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_remote_peering_connection.' if logger raise "Missing the required parameter 'remote_peering_connection_id' when calling delete_remote_peering_connection." if remote_peering_connection_id.nil? raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id) path = '/remotePeeringConnections/{remotePeeringConnectionId}'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_remote_peering_connection') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_route_table(rt_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_route_table API.
Deletes the specified route table, but only if it's not associated with a subnet. You can't delete a VCN's default route table.
This is an asynchronous operation. The route table's lifecycleState
will change to TERMINATING temporarily until the route table is completely removed.
5762 5763 5764 5765 5766 5767 5768 5769 5770 5771 5772 5773 5774 5775 5776 5777 5778 5779 5780 5781 5782 5783 5784 5785 5786 5787 5788 5789 5790 5791 5792 5793 5794 5795 5796 5797 |
# File 'lib/oci/core/virtual_network_client.rb', line 5762 def delete_route_table(rt_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_route_table.' if logger raise "Missing the required parameter 'rt_id' when calling delete_route_table." if rt_id.nil? raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id) path = '/routeTables/{rtId}'.sub('{rtId}', rt_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_route_table') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_security_list(security_list_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_security_list API.
Deletes the specified security list, but only if it's not associated with a subnet. You can't delete a VCN's default security list.
This is an asynchronous operation. The security list's lifecycleState
will change to TERMINATING temporarily until the security list is completely removed.
5823 5824 5825 5826 5827 5828 5829 5830 5831 5832 5833 5834 5835 5836 5837 5838 5839 5840 5841 5842 5843 5844 5845 5846 5847 5848 5849 5850 5851 5852 5853 5854 5855 5856 5857 5858 |
# File 'lib/oci/core/virtual_network_client.rb', line 5823 def delete_security_list(security_list_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_security_list.' if logger raise "Missing the required parameter 'security_list_id' when calling delete_security_list." if security_list_id.nil? raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id) path = '/securityLists/{securityListId}'.sub('{securityListId}', security_list_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_security_list') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_service_gateway(service_gateway_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_service_gateway API.
Deletes the specified service gateway. There must not be a route table that lists the service gateway as a target.
5881 5882 5883 5884 5885 5886 5887 5888 5889 5890 5891 5892 5893 5894 5895 5896 5897 5898 5899 5900 5901 5902 5903 5904 5905 5906 5907 5908 5909 5910 5911 5912 5913 5914 5915 5916 |
# File 'lib/oci/core/virtual_network_client.rb', line 5881 def delete_service_gateway(service_gateway_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_service_gateway.' if logger raise "Missing the required parameter 'service_gateway_id' when calling delete_service_gateway." if service_gateway_id.nil? raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id) path = '/serviceGateways/{serviceGatewayId}'.sub('{serviceGatewayId}', service_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_service_gateway') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_subnet(subnet_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_subnet API.
Deletes the specified subnet, but only if there are no instances in the subnet. This is an asynchronous operation. The subnet's lifecycleState
will change to TERMINATING temporarily. If there are any instances in the subnet, the state will instead change back to AVAILABLE.
5940 5941 5942 5943 5944 5945 5946 5947 5948 5949 5950 5951 5952 5953 5954 5955 5956 5957 5958 5959 5960 5961 5962 5963 5964 5965 5966 5967 5968 5969 5970 5971 5972 5973 5974 5975 |
# File 'lib/oci/core/virtual_network_client.rb', line 5940 def delete_subnet(subnet_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_subnet.' if logger raise "Missing the required parameter 'subnet_id' when calling delete_subnet." if subnet_id.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_subnet') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_vcn(vcn_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_vcn API.
Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous operation.
A deleted VCN's lifecycleState
changes to TERMINATING and then TERMINATED temporarily until the VCN is completely removed. A completely removed VCN does not appear in the results of a ListVcns
operation and can't be used in a GetVcn
operation.
6002 6003 6004 6005 6006 6007 6008 6009 6010 6011 6012 6013 6014 6015 6016 6017 6018 6019 6020 6021 6022 6023 6024 6025 6026 6027 6028 6029 6030 6031 6032 6033 6034 6035 6036 6037 |
# File 'lib/oci/core/virtual_network_client.rb', line 6002 def delete_vcn(vcn_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_vcn.' if logger raise "Missing the required parameter 'vcn_id' when calling delete_vcn." if vcn_id.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_vcn') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_virtual_circuit(virtual_circuit_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_virtual_circuit API.
Deletes the specified virtual circuit.
Important: If you're using FastConnect via a provider, make sure to also terminate the connection with the provider, or else the provider may continue to bill you.
6063 6064 6065 6066 6067 6068 6069 6070 6071 6072 6073 6074 6075 6076 6077 6078 6079 6080 6081 6082 6083 6084 6085 6086 6087 6088 6089 6090 6091 6092 6093 6094 6095 6096 6097 6098 |
# File 'lib/oci/core/virtual_network_client.rb', line 6063 def delete_virtual_circuit(virtual_circuit_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_virtual_circuit.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling delete_virtual_circuit." if virtual_circuit_id.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_virtual_circuit') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_vlan(vlan_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_vlan API.
Deletes the specified VLAN, but only if there are no VNICs in the VLAN.
6123 6124 6125 6126 6127 6128 6129 6130 6131 6132 6133 6134 6135 6136 6137 6138 6139 6140 6141 6142 6143 6144 6145 6146 6147 6148 6149 6150 6151 6152 6153 6154 6155 6156 6157 6158 6159 |
# File 'lib/oci/core/virtual_network_client.rb', line 6123 def delete_vlan(vlan_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_vlan.' if logger raise "Missing the required parameter 'vlan_id' when calling delete_vlan." if vlan_id.nil? raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id) path = '/vlans/{vlanId}'.sub('{vlanId}', vlan_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_vlan') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#delete_vtap(vtap_id, opts = {}) ⇒ Response
Click here to see an example of how to use delete_vtap API.
Deletes the specified VTAP. This is an asynchronous operation. The VTAP's lifecycleState
will change to TERMINATING temporarily until the VTAP is completely removed.
6185 6186 6187 6188 6189 6190 6191 6192 6193 6194 6195 6196 6197 6198 6199 6200 6201 6202 6203 6204 6205 6206 6207 6208 6209 6210 6211 6212 6213 6214 6215 6216 6217 6218 6219 6220 6221 |
# File 'lib/oci/core/virtual_network_client.rb', line 6185 def delete_vtap(vtap_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#delete_vtap.' if logger raise "Missing the required parameter 'vtap_id' when calling delete_vtap." if vtap_id.nil? raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id) path = '/vtaps/{vtapId}'.sub('{vtapId}', vtap_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#delete_vtap') do @api_client.call_api( :DELETE, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#detach_service_id(service_gateway_id, detach_service_details, opts = {}) ⇒ Response
Click here to see an example of how to use detach_service_id API.
Removes the specified Service from the list of enabled Service
objects for the specified gateway. You do not need to remove any route rules that specify this Service
object's cidrBlock
as the destination CIDR. However, consider removing the rules if your intent is to permanently disable use of the Service
through this service gateway.
Note: The DetachServiceId
operation is an easy way to remove an individual Service
from the service gateway. Compare it with update_service_gateway, which replaces the entire existing list of enabled Service
objects with the list that you provide in the Update
call. UpdateServiceGateway
also lets you block all traffic through the service gateway without having to remove each of the individual Service
objects.
6255 6256 6257 6258 6259 6260 6261 6262 6263 6264 6265 6266 6267 6268 6269 6270 6271 6272 6273 6274 6275 6276 6277 6278 6279 6280 6281 6282 6283 6284 6285 6286 6287 6288 6289 6290 6291 6292 |
# File 'lib/oci/core/virtual_network_client.rb', line 6255 def detach_service_id(service_gateway_id, detach_service_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#detach_service_id.' if logger raise "Missing the required parameter 'service_gateway_id' when calling detach_service_id." if service_gateway_id.nil? raise "Missing the required parameter 'detach_service_details' when calling detach_service_id." if detach_service_details.nil? raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id) path = '/serviceGateways/{serviceGatewayId}/actions/detachService'.sub('{serviceGatewayId}', service_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(detach_service_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#detach_service_id') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ServiceGateway' ) end # rubocop:enable Metrics/BlockLength end |
#get_all_drg_attachments(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_all_drg_attachments API.
Returns a complete list of DRG attachments that belong to a particular DRG.
6326 6327 6328 6329 6330 6331 6332 6333 6334 6335 6336 6337 6338 6339 6340 6341 6342 6343 6344 6345 6346 6347 6348 6349 6350 6351 6352 6353 6354 6355 6356 6357 6358 6359 6360 6361 6362 6363 6364 6365 6366 6367 6368 6369 6370 |
# File 'lib/oci/core/virtual_network_client.rb', line 6326 def (drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_all_drg_attachments.' if logger raise "Missing the required parameter 'drg_id' when calling get_all_drg_attachments." if drg_id.nil? if opts[:attachment_type] && !%w[VCN VIRTUAL_CIRCUIT REMOTE_PEERING_CONNECTION IPSEC_TUNNEL ALL].include?(opts[:attachment_type]) raise 'Invalid value for "attachment_type", must be one of VCN, VIRTUAL_CIRCUIT, REMOTE_PEERING_CONNECTION, IPSEC_TUNNEL, ALL.' end raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}/actions/getAllDrgAttachments'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:attachmentType] = opts[:attachment_type] if opts[:attachment_type] query_params[:isCrossTenancy] = opts[:is_cross_tenancy] if !opts[:is_cross_tenancy].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_all_drg_attachments') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgAttachmentInfo>' ) end # rubocop:enable Metrics/BlockLength end |
#get_allowed_ike_ip_sec_parameters(opts = {}) ⇒ Response
Click here to see an example of how to use get_allowed_ike_ip_sec_parameters API.
The parameters allowed for IKE IPSec tunnels.
6390 6391 6392 6393 6394 6395 6396 6397 6398 6399 6400 6401 6402 6403 6404 6405 6406 6407 6408 6409 6410 6411 6412 6413 6414 6415 6416 6417 6418 6419 6420 6421 6422 6423 6424 |
# File 'lib/oci/core/virtual_network_client.rb', line 6390 def get_allowed_ike_ip_sec_parameters(opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_allowed_ike_ip_sec_parameters.' if logger path = '/ipsecAlgorithms' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_allowed_ike_ip_sec_parameters') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::AllowedIkeIPSecParameters' ) end # rubocop:enable Metrics/BlockLength end |
#get_byoip_range(byoip_range_id, opts = {}) ⇒ Response
6445 6446 6447 6448 6449 6450 6451 6452 6453 6454 6455 6456 6457 6458 6459 6460 6461 6462 6463 6464 6465 6466 6467 6468 6469 6470 6471 6472 6473 6474 6475 6476 6477 6478 6479 6480 6481 |
# File 'lib/oci/core/virtual_network_client.rb', line 6445 def get_byoip_range(byoip_range_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_byoip_range.' if logger raise "Missing the required parameter 'byoip_range_id' when calling get_byoip_range." if byoip_range_id.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_byoip_range') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ByoipRange' ) end # rubocop:enable Metrics/BlockLength end |
#get_capture_filter(capture_filter_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_capture_filter API.
Gets information about the specified VTAP capture filter.
6501 6502 6503 6504 6505 6506 6507 6508 6509 6510 6511 6512 6513 6514 6515 6516 6517 6518 6519 6520 6521 6522 6523 6524 6525 6526 6527 6528 6529 6530 6531 6532 6533 6534 6535 6536 6537 |
# File 'lib/oci/core/virtual_network_client.rb', line 6501 def get_capture_filter(capture_filter_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_capture_filter.' if logger raise "Missing the required parameter 'capture_filter_id' when calling get_capture_filter." if capture_filter_id.nil? raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id) path = '/captureFilters/{captureFilterId}'.sub('{captureFilterId}', capture_filter_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_capture_filter') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CaptureFilter' ) end # rubocop:enable Metrics/BlockLength end |
#get_cpe(cpe_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_cpe API.
Gets the specified CPE's information.
6555 6556 6557 6558 6559 6560 6561 6562 6563 6564 6565 6566 6567 6568 6569 6570 6571 6572 6573 6574 6575 6576 6577 6578 6579 6580 6581 6582 6583 6584 6585 6586 6587 6588 6589 6590 |
# File 'lib/oci/core/virtual_network_client.rb', line 6555 def get_cpe(cpe_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_cpe.' if logger raise "Missing the required parameter 'cpe_id' when calling get_cpe." if cpe_id.nil? raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id) path = '/cpes/{cpeId}'.sub('{cpeId}', cpe_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cpe') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Cpe' ) end # rubocop:enable Metrics/BlockLength end |
#get_cpe_device_config_content(cpe_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_cpe_device_config_content API.
Renders a set of CPE configuration content that can help a network engineer configure the actual CPE device (for example, a hardware router) represented by the specified Cpe object.
The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe must have the CPE's device type specified by the cpeDeviceShapeId
attribute. The content optionally includes answers that the customer provides (see update_tunnel_cpe_device_config), merged with a template of other information specific to the CPE device type.
The operation returns configuration information for all of the IPSecConnection objects that use the specified CPE. Here are similar operations:
-
get_ipsec_cpe_device_config_content returns CPE configuration content for all IPSec tunnels in a single IPSec connection.
-
get_tunnel_cpe_device_config_content returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.
6631 6632 6633 6634 6635 6636 6637 6638 6639 6640 6641 6642 6643 6644 6645 6646 6647 6648 6649 6650 6651 6652 6653 6654 6655 6656 6657 6658 6659 6660 6661 6662 6663 6664 6665 6666 6667 6668 6669 6670 6671 6672 6673 6674 6675 6676 6677 6678 6679 6680 6681 6682 6683 6684 6685 6686 6687 6688 6689 6690 6691 6692 6693 6694 6695 6696 6697 6698 6699 6700 6701 6702 6703 6704 6705 6706 6707 6708 6709 6710 6711 |
# File 'lib/oci/core/virtual_network_client.rb', line 6631 def get_cpe_device_config_content(cpe_id, opts = {}, &block) logger.debug 'Calling operation VirtualNetworkClient#get_cpe_device_config_content.' if logger raise "Missing the required parameter 'cpe_id' when calling get_cpe_device_config_content." if cpe_id.nil? raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id) path = '/cpes/{cpeId}/cpeConfigContent'.sub('{cpeId}', cpe_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'text/plain; charset=utf-8' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cpe_device_config_content') do if !block.nil? @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_cpe_device_shape(cpe_device_shape_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_cpe_device_shape API.
Gets the detailed information about the specified CPE device type. This might include a set of questions that are specific to the particular CPE device type. The customer must supply answers to those questions (see update_tunnel_cpe_device_config). The service merges the answers with a template of other information for the CPE device type. The following operations return the merged content:
6740 6741 6742 6743 6744 6745 6746 6747 6748 6749 6750 6751 6752 6753 6754 6755 6756 6757 6758 6759 6760 6761 6762 6763 6764 6765 6766 6767 6768 6769 6770 6771 6772 6773 6774 6775 6776 |
# File 'lib/oci/core/virtual_network_client.rb', line 6740 def get_cpe_device_shape(cpe_device_shape_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_cpe_device_shape.' if logger raise "Missing the required parameter 'cpe_device_shape_id' when calling get_cpe_device_shape." if cpe_device_shape_id.nil? raise "Parameter value for 'cpe_device_shape_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_device_shape_id) path = '/cpeDeviceShapes/{cpeDeviceShapeId}'.sub('{cpeDeviceShapeId}', cpe_device_shape_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cpe_device_shape') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CpeDeviceShapeDetail' ) end # rubocop:enable Metrics/BlockLength end |
#get_cross_connect(cross_connect_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_cross_connect API.
Gets the specified cross-connect's information.
6794 6795 6796 6797 6798 6799 6800 6801 6802 6803 6804 6805 6806 6807 6808 6809 6810 6811 6812 6813 6814 6815 6816 6817 6818 6819 6820 6821 6822 6823 6824 6825 6826 6827 6828 6829 |
# File 'lib/oci/core/virtual_network_client.rb', line 6794 def get_cross_connect(cross_connect_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect.' if logger raise "Missing the required parameter 'cross_connect_id' when calling get_cross_connect." if cross_connect_id.nil? raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id) path = '/crossConnects/{crossConnectId}'.sub('{crossConnectId}', cross_connect_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnect' ) end # rubocop:enable Metrics/BlockLength end |
#get_cross_connect_group(cross_connect_group_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_cross_connect_group API.
Gets the specified cross-connect group's information.
6848 6849 6850 6851 6852 6853 6854 6855 6856 6857 6858 6859 6860 6861 6862 6863 6864 6865 6866 6867 6868 6869 6870 6871 6872 6873 6874 6875 6876 6877 6878 6879 6880 6881 6882 6883 |
# File 'lib/oci/core/virtual_network_client.rb', line 6848 def get_cross_connect_group(cross_connect_group_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect_group.' if logger raise "Missing the required parameter 'cross_connect_group_id' when calling get_cross_connect_group." if cross_connect_group_id.nil? raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id) path = '/crossConnectGroups/{crossConnectGroupId}'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect_group') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnectGroup' ) end # rubocop:enable Metrics/BlockLength end |
#get_cross_connect_letter_of_authority(cross_connect_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_cross_connect_letter_of_authority API.
Gets the Letter of Authority for the specified cross-connect.
6902 6903 6904 6905 6906 6907 6908 6909 6910 6911 6912 6913 6914 6915 6916 6917 6918 6919 6920 6921 6922 6923 6924 6925 6926 6927 6928 6929 6930 6931 6932 6933 6934 6935 6936 6937 |
# File 'lib/oci/core/virtual_network_client.rb', line 6902 def (cross_connect_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect_letter_of_authority.' if logger raise "Missing the required parameter 'cross_connect_id' when calling get_cross_connect_letter_of_authority." if cross_connect_id.nil? raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id) path = '/crossConnects/{crossConnectId}/letterOfAuthority'.sub('{crossConnectId}', cross_connect_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json, text/html' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect_letter_of_authority') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::LetterOfAuthority' ) end # rubocop:enable Metrics/BlockLength end |
#get_cross_connect_status(cross_connect_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_cross_connect_status API.
Gets the status of the specified cross-connect.
6957 6958 6959 6960 6961 6962 6963 6964 6965 6966 6967 6968 6969 6970 6971 6972 6973 6974 6975 6976 6977 6978 6979 6980 6981 6982 6983 6984 6985 6986 6987 6988 6989 6990 6991 6992 |
# File 'lib/oci/core/virtual_network_client.rb', line 6957 def get_cross_connect_status(cross_connect_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_cross_connect_status.' if logger raise "Missing the required parameter 'cross_connect_id' when calling get_cross_connect_status." if cross_connect_id.nil? raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id) path = '/crossConnects/{crossConnectId}/status'.sub('{crossConnectId}', cross_connect_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_cross_connect_status') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnectStatus' ) end # rubocop:enable Metrics/BlockLength end |
#get_dhcp_options(dhcp_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_dhcp_options API.
Gets the specified set of DHCP options.
7011 7012 7013 7014 7015 7016 7017 7018 7019 7020 7021 7022 7023 7024 7025 7026 7027 7028 7029 7030 7031 7032 7033 7034 7035 7036 7037 7038 7039 7040 7041 7042 7043 7044 7045 7046 |
# File 'lib/oci/core/virtual_network_client.rb', line 7011 def (dhcp_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_dhcp_options.' if logger raise "Missing the required parameter 'dhcp_id' when calling get_dhcp_options." if dhcp_id.nil? raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id) path = '/dhcps/{dhcpId}'.sub('{dhcpId}', dhcp_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_dhcp_options') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DhcpOptions' ) end # rubocop:enable Metrics/BlockLength end |
#get_drg(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_drg API.
Gets the specified DRG's information.
7065 7066 7067 7068 7069 7070 7071 7072 7073 7074 7075 7076 7077 7078 7079 7080 7081 7082 7083 7084 7085 7086 7087 7088 7089 7090 7091 7092 7093 7094 7095 7096 7097 7098 7099 7100 |
# File 'lib/oci/core/virtual_network_client.rb', line 7065 def get_drg(drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_drg.' if logger raise "Missing the required parameter 'drg_id' when calling get_drg." if drg_id.nil? raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Drg' ) end # rubocop:enable Metrics/BlockLength end |
#get_drg_attachment(drg_attachment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_drg_attachment API.
Gets the DrgAttachment
resource.
7119 7120 7121 7122 7123 7124 7125 7126 7127 7128 7129 7130 7131 7132 7133 7134 7135 7136 7137 7138 7139 7140 7141 7142 7143 7144 7145 7146 7147 7148 7149 7150 7151 7152 7153 7154 |
# File 'lib/oci/core/virtual_network_client.rb', line 7119 def (, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_drg_attachment.' if logger raise "Missing the required parameter 'drg_attachment_id' when calling get_drg_attachment." if .nil? raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/drgAttachments/{drgAttachmentId}'.sub('{drgAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_attachment') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#get_drg_redundancy_status(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_drg_redundancy_status API.
Gets the redundancy status for the specified DRG. For more information, see Redundancy Remedies.
7177 7178 7179 7180 7181 7182 7183 7184 7185 7186 7187 7188 7189 7190 7191 7192 7193 7194 7195 7196 7197 7198 7199 7200 7201 7202 7203 7204 7205 7206 7207 7208 7209 7210 7211 7212 7213 |
# File 'lib/oci/core/virtual_network_client.rb', line 7177 def get_drg_redundancy_status(drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_drg_redundancy_status.' if logger raise "Missing the required parameter 'drg_id' when calling get_drg_redundancy_status." if drg_id.nil? raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}/redundancyStatus'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_redundancy_status') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRedundancyStatus' ) end # rubocop:enable Metrics/BlockLength end |
#get_drg_route_distribution(drg_route_distribution_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_drg_route_distribution API.
Gets the specified route distribution's information.
7231 7232 7233 7234 7235 7236 7237 7238 7239 7240 7241 7242 7243 7244 7245 7246 7247 7248 7249 7250 7251 7252 7253 7254 7255 7256 7257 7258 7259 7260 7261 7262 7263 7264 7265 7266 |
# File 'lib/oci/core/virtual_network_client.rb', line 7231 def get_drg_route_distribution(drg_route_distribution_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_drg_route_distribution.' if logger raise "Missing the required parameter 'drg_route_distribution_id' when calling get_drg_route_distribution." if drg_route_distribution_id.nil? raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id) path = '/drgRouteDistributions/{drgRouteDistributionId}'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_route_distribution') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRouteDistribution' ) end # rubocop:enable Metrics/BlockLength end |
#get_drg_route_table(drg_route_table_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_drg_route_table API.
Gets the specified DRG route table's information.
7285 7286 7287 7288 7289 7290 7291 7292 7293 7294 7295 7296 7297 7298 7299 7300 7301 7302 7303 7304 7305 7306 7307 7308 7309 7310 7311 7312 7313 7314 7315 7316 7317 7318 7319 7320 |
# File 'lib/oci/core/virtual_network_client.rb', line 7285 def get_drg_route_table(drg_route_table_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_drg_route_table.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling get_drg_route_table." if drg_route_table_id.nil? raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_drg_route_table') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRouteTable' ) end # rubocop:enable Metrics/BlockLength end |
#get_fast_connect_provider_service(provider_service_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_fast_connect_provider_service API.
Gets the specified provider service. For more information, see FastConnect Overview.
7341 7342 7343 7344 7345 7346 7347 7348 7349 7350 7351 7352 7353 7354 7355 7356 7357 7358 7359 7360 7361 7362 7363 7364 7365 7366 7367 7368 7369 7370 7371 7372 7373 7374 7375 7376 |
# File 'lib/oci/core/virtual_network_client.rb', line 7341 def get_fast_connect_provider_service(provider_service_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_fast_connect_provider_service.' if logger raise "Missing the required parameter 'provider_service_id' when calling get_fast_connect_provider_service." if provider_service_id.nil? raise "Parameter value for 'provider_service_id' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_id) path = '/fastConnectProviderServices/{providerServiceId}'.sub('{providerServiceId}', provider_service_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_fast_connect_provider_service') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::FastConnectProviderService' ) end # rubocop:enable Metrics/BlockLength end |
#get_fast_connect_provider_service_key(provider_service_id, provider_service_key_name, opts = {}) ⇒ Response
Click here to see an example of how to use get_fast_connect_provider_service_key API.
Gets the specified provider service key's information. Use this operation to validate a provider service key. An invalid key returns a 404 error.
7402 7403 7404 7405 7406 7407 7408 7409 7410 7411 7412 7413 7414 7415 7416 7417 7418 7419 7420 7421 7422 7423 7424 7425 7426 7427 7428 7429 7430 7431 7432 7433 7434 7435 7436 7437 7438 7439 |
# File 'lib/oci/core/virtual_network_client.rb', line 7402 def get_fast_connect_provider_service_key(provider_service_id, provider_service_key_name, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_fast_connect_provider_service_key.' if logger raise "Missing the required parameter 'provider_service_id' when calling get_fast_connect_provider_service_key." if provider_service_id.nil? raise "Missing the required parameter 'provider_service_key_name' when calling get_fast_connect_provider_service_key." if provider_service_key_name.nil? raise "Parameter value for 'provider_service_id' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_id) raise "Parameter value for 'provider_service_key_name' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_key_name) path = '/fastConnectProviderServices/{providerServiceId}/providerServiceKeys/{providerServiceKeyName}'.sub('{providerServiceId}', provider_service_id.to_s).sub('{providerServiceKeyName}', provider_service_key_name.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_fast_connect_provider_service_key') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::FastConnectProviderServiceKey' ) end # rubocop:enable Metrics/BlockLength end |
#get_internet_gateway(ig_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_internet_gateway API.
Gets the specified internet gateway's information.
7458 7459 7460 7461 7462 7463 7464 7465 7466 7467 7468 7469 7470 7471 7472 7473 7474 7475 7476 7477 7478 7479 7480 7481 7482 7483 7484 7485 7486 7487 7488 7489 7490 7491 7492 7493 |
# File 'lib/oci/core/virtual_network_client.rb', line 7458 def get_internet_gateway(ig_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_internet_gateway.' if logger raise "Missing the required parameter 'ig_id' when calling get_internet_gateway." if ig_id.nil? raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id) path = '/internetGateways/{igId}'.sub('{igId}', ig_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_internet_gateway') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::InternetGateway' ) end # rubocop:enable Metrics/BlockLength end |
#get_ip_sec_connection(ipsc_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ip_sec_connection API.
Gets the specified IPSec connection's basic information, including the static routes for the on-premises router. If you want the status of the connection (whether it's up or down), use get_ip_sec_connection_tunnel.
7515 7516 7517 7518 7519 7520 7521 7522 7523 7524 7525 7526 7527 7528 7529 7530 7531 7532 7533 7534 7535 7536 7537 7538 7539 7540 7541 7542 7543 7544 7545 7546 7547 7548 7549 7550 |
# File 'lib/oci/core/virtual_network_client.rb', line 7515 def get_ip_sec_connection(ipsc_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection." if ipsc_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnection' ) end # rubocop:enable Metrics/BlockLength end |
#get_ip_sec_connection_device_config(ipsc_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ip_sec_connection_device_config API.
Deprecated. To get tunnel information, instead use:
7573 7574 7575 7576 7577 7578 7579 7580 7581 7582 7583 7584 7585 7586 7587 7588 7589 7590 7591 7592 7593 7594 7595 7596 7597 7598 7599 7600 7601 7602 7603 7604 7605 7606 7607 7608 |
# File 'lib/oci/core/virtual_network_client.rb', line 7573 def get_ip_sec_connection_device_config(ipsc_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_device_config.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_device_config." if ipsc_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}/deviceConfig'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_device_config') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnectionDeviceConfig' ) end # rubocop:enable Metrics/BlockLength end |
#get_ip_sec_connection_device_status(ipsc_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ip_sec_connection_device_status API.
Deprecated. To get the tunnel status, instead use get_ip_sec_connection_tunnel.
7629 7630 7631 7632 7633 7634 7635 7636 7637 7638 7639 7640 7641 7642 7643 7644 7645 7646 7647 7648 7649 7650 7651 7652 7653 7654 7655 7656 7657 7658 7659 7660 7661 7662 7663 7664 |
# File 'lib/oci/core/virtual_network_client.rb', line 7629 def get_ip_sec_connection_device_status(ipsc_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_device_status.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_device_status." if ipsc_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}/deviceStatus'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_device_status') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnectionDeviceStatus' ) end # rubocop:enable Metrics/BlockLength end |
#get_ip_sec_connection_tunnel(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ip_sec_connection_tunnel API.
Gets the specified tunnel's information. The resulting object does not include the tunnel's shared secret (pre-shared key). To retrieve that, use get_ip_sec_connection_tunnel_shared_secret.
7687 7688 7689 7690 7691 7692 7693 7694 7695 7696 7697 7698 7699 7700 7701 7702 7703 7704 7705 7706 7707 7708 7709 7710 7711 7712 7713 7714 7715 7716 7717 7718 7719 7720 7721 7722 7723 7724 |
# File 'lib/oci/core/virtual_network_client.rb', line 7687 def get_ip_sec_connection_tunnel(ipsc_id, tunnel_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_tunnel.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_tunnel." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling get_ip_sec_connection_tunnel." if tunnel_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_tunnel') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnectionTunnel' ) end # rubocop:enable Metrics/BlockLength end |
#get_ip_sec_connection_tunnel_error(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ip_sec_connection_tunnel_error API.
Gets the identified error for the specified IPSec tunnel ID.
7745 7746 7747 7748 7749 7750 7751 7752 7753 7754 7755 7756 7757 7758 7759 7760 7761 7762 7763 7764 7765 7766 7767 7768 7769 7770 7771 7772 7773 7774 7775 7776 7777 7778 7779 7780 7781 7782 |
# File 'lib/oci/core/virtual_network_client.rb', line 7745 def get_ip_sec_connection_tunnel_error(ipsc_id, tunnel_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_tunnel_error.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_tunnel_error." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling get_ip_sec_connection_tunnel_error." if tunnel_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/error'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_tunnel_error') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnectionTunnelErrorDetails' ) end # rubocop:enable Metrics/BlockLength end |
#get_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ip_sec_connection_tunnel_shared_secret API.
Gets the specified tunnel's shared secret (pre-shared key). To get other information about the tunnel, use get_ip_sec_connection_tunnel.
7804 7805 7806 7807 7808 7809 7810 7811 7812 7813 7814 7815 7816 7817 7818 7819 7820 7821 7822 7823 7824 7825 7826 7827 7828 7829 7830 7831 7832 7833 7834 7835 7836 7837 7838 7839 7840 7841 |
# File 'lib/oci/core/virtual_network_client.rb', line 7804 def get_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_ip_sec_connection_tunnel_shared_secret.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_ip_sec_connection_tunnel_shared_secret." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling get_ip_sec_connection_tunnel_shared_secret." if tunnel_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ip_sec_connection_tunnel_shared_secret') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnectionTunnelSharedSecret' ) end # rubocop:enable Metrics/BlockLength end |
#get_ipsec_cpe_device_config_content(ipsc_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_ipsec_cpe_device_config_content API.
Renders a set of CPE configuration content for the specified IPSec connection (for all the tunnels in the connection). The content helps a network engineer configure the actual CPE device (for example, a hardware router) that the specified IPSec connection terminates on.
The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe used by the specified IPSecConnection must have the CPE's device type specified by the cpeDeviceShapeId
attribute. The content optionally includes answers that the customer provides (see update_tunnel_cpe_device_config), merged with a template of other information specific to the CPE device type.
The operation returns configuration information for all tunnels in the single specified IPSecConnection object. Here are other similar operations:
-
get_tunnel_cpe_device_config_content returns CPE configuration content for a specific tunnel within an IPSec connection.
-
get_cpe_device_config_content returns CPE configuration content for all IPSec connections that use a specific CPE.
7883 7884 7885 7886 7887 7888 7889 7890 7891 7892 7893 7894 7895 7896 7897 7898 7899 7900 7901 7902 7903 7904 7905 7906 7907 7908 7909 7910 7911 7912 7913 7914 7915 7916 7917 7918 7919 7920 7921 7922 7923 7924 7925 7926 7927 7928 7929 7930 7931 7932 7933 7934 7935 7936 7937 7938 7939 7940 7941 7942 7943 7944 7945 7946 7947 7948 7949 7950 7951 7952 7953 7954 7955 7956 7957 7958 7959 7960 7961 7962 7963 |
# File 'lib/oci/core/virtual_network_client.rb', line 7883 def get_ipsec_cpe_device_config_content(ipsc_id, opts = {}, &block) logger.debug 'Calling operation VirtualNetworkClient#get_ipsec_cpe_device_config_content.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_ipsec_cpe_device_config_content." if ipsc_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}/cpeConfigContent'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'text/plain; charset=utf-8' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ipsec_cpe_device_config_content') do if !block.nil? @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_ipv6(ipv6_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_ipv6 API.
Gets the specified IPv6. You must specify the object's OCID. Alternatively, you can get the object by using #list_ipv6s list_ipv6s} with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet {OCID.
7987 7988 7989 7990 7991 7992 7993 7994 7995 7996 7997 7998 7999 8000 8001 8002 8003 8004 8005 8006 8007 8008 8009 8010 8011 8012 8013 8014 8015 8016 8017 8018 8019 8020 8021 8022 8023 |
# File 'lib/oci/core/virtual_network_client.rb', line 7987 def get_ipv6(ipv6_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_ipv6.' if logger raise "Missing the required parameter 'ipv6_id' when calling get_ipv6." if ipv6_id.nil? raise "Parameter value for 'ipv6_id' must not be blank" if OCI::Internal::Util.blank_string?(ipv6_id) path = '/ipv6/{ipv6Id}'.sub('{ipv6Id}', ipv6_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_ipv6') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Ipv6' ) end # rubocop:enable Metrics/BlockLength end |
#get_local_peering_gateway(local_peering_gateway_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_local_peering_gateway API.
Gets the specified local peering gateway's information.
8041 8042 8043 8044 8045 8046 8047 8048 8049 8050 8051 8052 8053 8054 8055 8056 8057 8058 8059 8060 8061 8062 8063 8064 8065 8066 8067 8068 8069 8070 8071 8072 8073 8074 8075 8076 |
# File 'lib/oci/core/virtual_network_client.rb', line 8041 def get_local_peering_gateway(local_peering_gateway_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_local_peering_gateway.' if logger raise "Missing the required parameter 'local_peering_gateway_id' when calling get_local_peering_gateway." if local_peering_gateway_id.nil? raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id) path = '/localPeeringGateways/{localPeeringGatewayId}'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_local_peering_gateway') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::LocalPeeringGateway' ) end # rubocop:enable Metrics/BlockLength end |
#get_nat_gateway(nat_gateway_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_nat_gateway API.
Gets the specified NAT gateway's information.
8095 8096 8097 8098 8099 8100 8101 8102 8103 8104 8105 8106 8107 8108 8109 8110 8111 8112 8113 8114 8115 8116 8117 8118 8119 8120 8121 8122 8123 8124 8125 8126 8127 8128 8129 8130 |
# File 'lib/oci/core/virtual_network_client.rb', line 8095 def get_nat_gateway(nat_gateway_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_nat_gateway.' if logger raise "Missing the required parameter 'nat_gateway_id' when calling get_nat_gateway." if nat_gateway_id.nil? raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id) path = '/natGateways/{natGatewayId}'.sub('{natGatewayId}', nat_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_nat_gateway') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::NatGateway' ) end # rubocop:enable Metrics/BlockLength end |
#get_network_security_group(network_security_group_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_network_security_group API.
Gets the specified network security group's information.
To list the VNICs in an NSG, see list_network_security_group_vnics.
To list the security rules in an NSG, see list_network_security_group_security_rules.
8156 8157 8158 8159 8160 8161 8162 8163 8164 8165 8166 8167 8168 8169 8170 8171 8172 8173 8174 8175 8176 8177 8178 8179 8180 8181 8182 8183 8184 8185 8186 8187 8188 8189 8190 8191 |
# File 'lib/oci/core/virtual_network_client.rb', line 8156 def get_network_security_group(network_security_group_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_network_security_group.' if logger raise "Missing the required parameter 'network_security_group_id' when calling get_network_security_group." if network_security_group_id.nil? raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_network_security_group') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::NetworkSecurityGroup' ) end # rubocop:enable Metrics/BlockLength end |
#get_networking_topology(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_networking_topology API.
Gets a virtual networking topology for the current region.
8235 8236 8237 8238 8239 8240 8241 8242 8243 8244 8245 8246 8247 8248 8249 8250 8251 8252 8253 8254 8255 8256 8257 8258 8259 8260 8261 8262 8263 8264 8265 8266 8267 8268 8269 8270 8271 8272 8273 8274 8275 8276 8277 8278 8279 |
# File 'lib/oci/core/virtual_network_client.rb', line 8235 def get_networking_topology(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_networking_topology.' if logger raise "Missing the required parameter 'compartment_id' when calling get_networking_topology." if compartment_id.nil? if opts[:access_level] && !%w[ANY ACCESSIBLE].include?(opts[:access_level]) raise 'Invalid value for "access_level", must be one of ANY, ACCESSIBLE.' end path = '/networkingTopology' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:accessLevel] = opts[:access_level] if opts[:access_level] query_params[:queryCompartmentSubtree] = opts[:query_compartment_subtree] if !opts[:query_compartment_subtree].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_networking_topology') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::NetworkingTopology' ) end # rubocop:enable Metrics/BlockLength end |
#get_private_ip(private_ip_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_private_ip API.
Gets the specified private IP. You must specify the object's OCID. Alternatively, you can get the object by using #list_private_ips list_private_ips} with the private IP address (for example, 10.0.3.3) and subnet {OCID.
8301 8302 8303 8304 8305 8306 8307 8308 8309 8310 8311 8312 8313 8314 8315 8316 8317 8318 8319 8320 8321 8322 8323 8324 8325 8326 8327 8328 8329 8330 8331 8332 8333 8334 8335 8336 |
# File 'lib/oci/core/virtual_network_client.rb', line 8301 def get_private_ip(private_ip_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_private_ip.' if logger raise "Missing the required parameter 'private_ip_id' when calling get_private_ip." if private_ip_id.nil? raise "Parameter value for 'private_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(private_ip_id) path = '/privateIps/{privateIpId}'.sub('{privateIpId}', private_ip_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_private_ip') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PrivateIp' ) end # rubocop:enable Metrics/BlockLength end |
#get_public_ip(public_ip_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_public_ip API.
Gets the specified public IP. You must specify the object's OCID.
Alternatively, you can get the object by using get_public_ip_by_ip_address with the public IP address (for example, 203.0.113.2).
Or you can use #get_public_ip_by_private_ip_id get_public_ip_by_private_ip_id} with the {OCID of the private IP that the public IP is assigned to.
Note: If you're fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with lifecycleState
= ASSIGNING and assignedEntityId
= OCID of the target private IP.
8366 8367 8368 8369 8370 8371 8372 8373 8374 8375 8376 8377 8378 8379 8380 8381 8382 8383 8384 8385 8386 8387 8388 8389 8390 8391 8392 8393 8394 8395 8396 8397 8398 8399 8400 8401 |
# File 'lib/oci/core/virtual_network_client.rb', line 8366 def get_public_ip(public_ip_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_public_ip.' if logger raise "Missing the required parameter 'public_ip_id' when calling get_public_ip." if public_ip_id.nil? raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id) path = '/publicIps/{publicIpId}'.sub('{publicIpId}', public_ip_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIp' ) end # rubocop:enable Metrics/BlockLength end |
#get_public_ip_by_ip_address(get_public_ip_by_ip_address_details, opts = {}) ⇒ Response
Click here to see an example of how to use get_public_ip_by_ip_address API.
Gets the public IP based on the public IP address (for example, 203.0.113.2).
Note: If you're fetching a reserved public IP that is in the process of being moved to a different private IP, the service returns the public IP object with lifecycleState
= ASSIGNING and assignedEntityId
= OCID of the target private IP.
8425 8426 8427 8428 8429 8430 8431 8432 8433 8434 8435 8436 8437 8438 8439 8440 8441 8442 8443 8444 8445 8446 8447 8448 8449 8450 8451 8452 8453 8454 8455 8456 8457 8458 8459 |
# File 'lib/oci/core/virtual_network_client.rb', line 8425 def get_public_ip_by_ip_address(get_public_ip_by_ip_address_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_public_ip_by_ip_address.' if logger raise "Missing the required parameter 'get_public_ip_by_ip_address_details' when calling get_public_ip_by_ip_address." if get_public_ip_by_ip_address_details.nil? path = '/publicIps/actions/getByIpAddress' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(get_public_ip_by_ip_address_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip_by_ip_address') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIp' ) end # rubocop:enable Metrics/BlockLength end |
#get_public_ip_by_private_ip_id(get_public_ip_by_private_ip_id_details, opts = {}) ⇒ Response
Click here to see an example of how to use get_public_ip_by_private_ip_id API.
Gets the public IP assigned to the specified private IP. You must specify the OCID of the private IP. If no public IP is assigned, a 404 is returned.
Note: If you're fetching a reserved public IP that is in the process of being moved to a different private IP, and you provide the OCID of the original private IP, this operation returns a 404. If you instead provide the OCID of the target private IP, or if you instead call #get_public_ip get_public_ip} or get_public_ip_by_ip_address, the service returns the public IP object with lifecycleState = ASSIGNING and assignedEntityId = {OCID of the target private IP.
8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 8499 8500 8501 8502 8503 8504 8505 8506 8507 8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 8519 8520 8521 8522 8523 |
# File 'lib/oci/core/virtual_network_client.rb', line 8489 def get_public_ip_by_private_ip_id(get_public_ip_by_private_ip_id_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_public_ip_by_private_ip_id.' if logger raise "Missing the required parameter 'get_public_ip_by_private_ip_id_details' when calling get_public_ip_by_private_ip_id." if get_public_ip_by_private_ip_id_details.nil? path = '/publicIps/actions/getByPrivateIpId' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(get_public_ip_by_private_ip_id_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip_by_private_ip_id') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIp' ) end # rubocop:enable Metrics/BlockLength end |
#get_public_ip_pool(public_ip_pool_id, opts = {}) ⇒ Response
8545 8546 8547 8548 8549 8550 8551 8552 8553 8554 8555 8556 8557 8558 8559 8560 8561 8562 8563 8564 8565 8566 8567 8568 8569 8570 8571 8572 8573 8574 8575 8576 8577 8578 8579 8580 8581 |
# File 'lib/oci/core/virtual_network_client.rb', line 8545 def get_public_ip_pool(public_ip_pool_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_public_ip_pool.' if logger raise "Missing the required parameter 'public_ip_pool_id' when calling get_public_ip_pool." if public_ip_pool_id.nil? raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id) path = '/publicIpPools/{publicIpPoolId}'.sub('{publicIpPoolId}', public_ip_pool_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_public_ip_pool') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIpPool' ) end # rubocop:enable Metrics/BlockLength end |
#get_remote_peering_connection(remote_peering_connection_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_remote_peering_connection API.
Get the specified remote peering connection's information.
8600 8601 8602 8603 8604 8605 8606 8607 8608 8609 8610 8611 8612 8613 8614 8615 8616 8617 8618 8619 8620 8621 8622 8623 8624 8625 8626 8627 8628 8629 8630 8631 8632 8633 8634 8635 |
# File 'lib/oci/core/virtual_network_client.rb', line 8600 def get_remote_peering_connection(remote_peering_connection_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_remote_peering_connection.' if logger raise "Missing the required parameter 'remote_peering_connection_id' when calling get_remote_peering_connection." if remote_peering_connection_id.nil? raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id) path = '/remotePeeringConnections/{remotePeeringConnectionId}'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_remote_peering_connection') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::RemotePeeringConnection' ) end # rubocop:enable Metrics/BlockLength end |
#get_resource_ip_inventory(data_request_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_resource_ip_inventory API.
Gets the IpInventory
resource.
8657 8658 8659 8660 8661 8662 8663 8664 8665 8666 8667 8668 8669 8670 8671 8672 8673 8674 8675 8676 8677 8678 8679 8680 8681 8682 8683 8684 8685 8686 8687 8688 8689 8690 8691 8692 8693 |
# File 'lib/oci/core/virtual_network_client.rb', line 8657 def get_resource_ip_inventory(data_request_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_resource_ip_inventory.' if logger raise "Missing the required parameter 'data_request_id' when calling get_resource_ip_inventory." if data_request_id.nil? raise "Parameter value for 'data_request_id' must not be blank" if OCI::Internal::Util.blank_string?(data_request_id) path = '/ipinventory/DataRequestId/{dataRequestId}'.sub('{dataRequestId}', data_request_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_resource_ip_inventory') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IpInventoryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#get_route_table(rt_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_route_table API.
Gets the specified route table's information.
8711 8712 8713 8714 8715 8716 8717 8718 8719 8720 8721 8722 8723 8724 8725 8726 8727 8728 8729 8730 8731 8732 8733 8734 8735 8736 8737 8738 8739 8740 8741 8742 8743 8744 8745 8746 |
# File 'lib/oci/core/virtual_network_client.rb', line 8711 def get_route_table(rt_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_route_table.' if logger raise "Missing the required parameter 'rt_id' when calling get_route_table." if rt_id.nil? raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id) path = '/routeTables/{rtId}'.sub('{rtId}', rt_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_route_table') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::RouteTable' ) end # rubocop:enable Metrics/BlockLength end |
#get_security_list(security_list_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_security_list API.
Gets the specified security list's information.
8765 8766 8767 8768 8769 8770 8771 8772 8773 8774 8775 8776 8777 8778 8779 8780 8781 8782 8783 8784 8785 8786 8787 8788 8789 8790 8791 8792 8793 8794 8795 8796 8797 8798 8799 8800 |
# File 'lib/oci/core/virtual_network_client.rb', line 8765 def get_security_list(security_list_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_security_list.' if logger raise "Missing the required parameter 'security_list_id' when calling get_security_list." if security_list_id.nil? raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id) path = '/securityLists/{securityListId}'.sub('{securityListId}', security_list_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_security_list') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::SecurityList' ) end # rubocop:enable Metrics/BlockLength end |
#get_service(service_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_service API.
Gets the specified Service object.
8820 8821 8822 8823 8824 8825 8826 8827 8828 8829 8830 8831 8832 8833 8834 8835 8836 8837 8838 8839 8840 8841 8842 8843 8844 8845 8846 8847 8848 8849 8850 8851 8852 8853 8854 8855 |
# File 'lib/oci/core/virtual_network_client.rb', line 8820 def get_service(service_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_service.' if logger raise "Missing the required parameter 'service_id' when calling get_service." if service_id.nil? raise "Parameter value for 'service_id' must not be blank" if OCI::Internal::Util.blank_string?(service_id) path = '/services/{serviceId}'.sub('{serviceId}', service_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_service') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Service' ) end # rubocop:enable Metrics/BlockLength end |
#get_service_gateway(service_gateway_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_service_gateway API.
Gets the specified service gateway's information.
8874 8875 8876 8877 8878 8879 8880 8881 8882 8883 8884 8885 8886 8887 8888 8889 8890 8891 8892 8893 8894 8895 8896 8897 8898 8899 8900 8901 8902 8903 8904 8905 8906 8907 8908 8909 |
# File 'lib/oci/core/virtual_network_client.rb', line 8874 def get_service_gateway(service_gateway_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_service_gateway.' if logger raise "Missing the required parameter 'service_gateway_id' when calling get_service_gateway." if service_gateway_id.nil? raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id) path = '/serviceGateways/{serviceGatewayId}'.sub('{serviceGatewayId}', service_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_service_gateway') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ServiceGateway' ) end # rubocop:enable Metrics/BlockLength end |
#get_subnet(subnet_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_subnet API.
Gets the specified subnet's information.
8928 8929 8930 8931 8932 8933 8934 8935 8936 8937 8938 8939 8940 8941 8942 8943 8944 8945 8946 8947 8948 8949 8950 8951 8952 8953 8954 8955 8956 8957 8958 8959 8960 8961 8962 8963 |
# File 'lib/oci/core/virtual_network_client.rb', line 8928 def get_subnet(subnet_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_subnet.' if logger raise "Missing the required parameter 'subnet_id' when calling get_subnet." if subnet_id.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Subnet' ) end # rubocop:enable Metrics/BlockLength end |
#get_subnet_cidr_utilization(subnet_id, opts = {}) ⇒ Response
8985 8986 8987 8988 8989 8990 8991 8992 8993 8994 8995 8996 8997 8998 8999 9000 9001 9002 9003 9004 9005 9006 9007 9008 9009 9010 9011 9012 9013 9014 9015 9016 9017 9018 9019 9020 9021 |
# File 'lib/oci/core/virtual_network_client.rb', line 8985 def get_subnet_cidr_utilization(subnet_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_subnet_cidr_utilization.' if logger raise "Missing the required parameter 'subnet_id' when calling get_subnet_cidr_utilization." if subnet_id.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/ipInventory/subnets/{subnetId}/cidrs'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet_cidr_utilization') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IpInventoryCidrUtilizationCollection' ) end # rubocop:enable Metrics/BlockLength end |
#get_subnet_ip_inventory(subnet_id, opts = {}) ⇒ Response
9042 9043 9044 9045 9046 9047 9048 9049 9050 9051 9052 9053 9054 9055 9056 9057 9058 9059 9060 9061 9062 9063 9064 9065 9066 9067 9068 9069 9070 9071 9072 9073 9074 9075 9076 9077 9078 |
# File 'lib/oci/core/virtual_network_client.rb', line 9042 def get_subnet_ip_inventory(subnet_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_subnet_ip_inventory.' if logger raise "Missing the required parameter 'subnet_id' when calling get_subnet_ip_inventory." if subnet_id.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/ipInventory/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet_ip_inventory') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IpInventorySubnetResourceCollection' ) end # rubocop:enable Metrics/BlockLength end |
#get_subnet_topology(compartment_id, subnet_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_subnet_topology API.
Gets a topology for a given subnet.
9122 9123 9124 9125 9126 9127 9128 9129 9130 9131 9132 9133 9134 9135 9136 9137 9138 9139 9140 9141 9142 9143 9144 9145 9146 9147 9148 9149 9150 9151 9152 9153 9154 9155 9156 9157 9158 9159 9160 9161 9162 9163 9164 9165 9166 9167 9168 |
# File 'lib/oci/core/virtual_network_client.rb', line 9122 def get_subnet_topology(compartment_id, subnet_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_subnet_topology.' if logger raise "Missing the required parameter 'compartment_id' when calling get_subnet_topology." if compartment_id.nil? raise "Missing the required parameter 'subnet_id' when calling get_subnet_topology." if subnet_id.nil? if opts[:access_level] && !%w[ANY ACCESSIBLE].include?(opts[:access_level]) raise 'Invalid value for "access_level", must be one of ANY, ACCESSIBLE.' end path = '/subnetTopology' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:subnetId] = subnet_id query_params[:accessLevel] = opts[:access_level] if opts[:access_level] query_params[:queryCompartmentSubtree] = opts[:query_compartment_subtree] if !opts[:query_compartment_subtree].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_subnet_topology') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::SubnetTopology' ) end # rubocop:enable Metrics/BlockLength end |
#get_tunnel_cpe_device_config(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_tunnel_cpe_device_config API.
Gets the set of CPE configuration answers for the tunnel, which the customer provided in update_tunnel_cpe_device_config. To get the full set of content for the tunnel (any answers merged with the template of other information specific to the CPE device type), use get_tunnel_cpe_device_config_content.
9194 9195 9196 9197 9198 9199 9200 9201 9202 9203 9204 9205 9206 9207 9208 9209 9210 9211 9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 |
# File 'lib/oci/core/virtual_network_client.rb', line 9194 def get_tunnel_cpe_device_config(ipsc_id, tunnel_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_tunnel_cpe_device_config.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_tunnel_cpe_device_config." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling get_tunnel_cpe_device_config." if tunnel_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_tunnel_cpe_device_config') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::TunnelCpeDeviceConfig' ) end # rubocop:enable Metrics/BlockLength end |
#get_tunnel_cpe_device_config_content(ipsc_id, tunnel_id, opts = {}, &block) ⇒ Response
Click here to see an example of how to use get_tunnel_cpe_device_config_content API.
Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a network engineer configure the actual CPE device (for example, a hardware router) that the specified IPSec tunnel terminates on.
The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe used by the specified IPSecConnection must have the CPE's device type specified by the cpeDeviceShapeId
attribute. The content optionally includes answers that the customer provides (see update_tunnel_cpe_device_config), merged with a template of other information specific to the CPE device type.
The operation returns configuration information for only the specified IPSec tunnel. Here are other similar operations:
-
get_ipsec_cpe_device_config_content returns CPE configuration content for all tunnels in a single IPSec connection.
-
get_cpe_device_config_content returns CPE configuration content for all IPSec connections that use a specific CPE.
9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 9316 9317 9318 9319 9320 9321 9322 9323 9324 9325 9326 9327 9328 9329 9330 9331 9332 9333 9334 9335 9336 9337 9338 9339 9340 9341 9342 9343 9344 9345 9346 9347 9348 9349 9350 9351 9352 9353 9354 9355 |
# File 'lib/oci/core/virtual_network_client.rb', line 9273 def get_tunnel_cpe_device_config_content(ipsc_id, tunnel_id, opts = {}, &block) logger.debug 'Calling operation VirtualNetworkClient#get_tunnel_cpe_device_config_content.' if logger raise "Missing the required parameter 'ipsc_id' when calling get_tunnel_cpe_device_config_content." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling get_tunnel_cpe_device_config_content." if tunnel_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig/content'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = opts[:accept] if opts[:accept] header_params[:accept] ||= 'text/plain; charset=utf-8' header_params[:'accept-encoding'] = opts[:accept_encoding] if opts[:accept_encoding] header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_tunnel_cpe_device_config_content') do if !block.nil? @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &block ) elsif opts[:response_target] if opts[:response_target].respond_to? :write @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| opts[:response_target].write(chunk) } ) elsif opts[:response_target].is_a?(String) File.open(opts[:response_target], 'wb') do |output| return @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Stream', &proc { |chunk, _response| output.write(chunk) } ) end end else @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'String' ) end end # rubocop:enable Metrics/BlockLength end |
#get_upgrade_status(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_upgrade_status API.
Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.
9376 9377 9378 9379 9380 9381 9382 9383 9384 9385 9386 9387 9388 9389 9390 9391 9392 9393 9394 9395 9396 9397 9398 9399 9400 9401 9402 9403 9404 9405 9406 9407 9408 9409 9410 9411 9412 |
# File 'lib/oci/core/virtual_network_client.rb', line 9376 def get_upgrade_status(drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_upgrade_status.' if logger raise "Missing the required parameter 'drg_id' when calling get_upgrade_status." if drg_id.nil? raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}/actions/upgradeStatus'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_upgrade_status') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::UpgradeStatus' ) end # rubocop:enable Metrics/BlockLength end |
#get_vcn(vcn_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_vcn API.
Gets the specified VCN's information.
9430 9431 9432 9433 9434 9435 9436 9437 9438 9439 9440 9441 9442 9443 9444 9445 9446 9447 9448 9449 9450 9451 9452 9453 9454 9455 9456 9457 9458 9459 9460 9461 9462 9463 9464 9465 |
# File 'lib/oci/core/virtual_network_client.rb', line 9430 def get_vcn(vcn_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_vcn.' if logger raise "Missing the required parameter 'vcn_id' when calling get_vcn." if vcn_id.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vcn' ) end # rubocop:enable Metrics/BlockLength end |
#get_vcn_dns_resolver_association(vcn_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_vcn_dns_resolver_association API.
Get the associated DNS resolver information with a vcn
9486 9487 9488 9489 9490 9491 9492 9493 9494 9495 9496 9497 9498 9499 9500 9501 9502 9503 9504 9505 9506 9507 9508 9509 9510 9511 9512 9513 9514 9515 9516 9517 9518 9519 9520 9521 9522 |
# File 'lib/oci/core/virtual_network_client.rb', line 9486 def get_vcn_dns_resolver_association(vcn_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_vcn_dns_resolver_association.' if logger raise "Missing the required parameter 'vcn_id' when calling get_vcn_dns_resolver_association." if vcn_id.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}/dnsResolverAssociation'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn_dns_resolver_association') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VcnDnsResolverAssociation' ) end # rubocop:enable Metrics/BlockLength end |
#get_vcn_overlap(vcn_id, get_vcn_overlap_details, opts = {}) ⇒ Response
9550 9551 9552 9553 9554 9555 9556 9557 9558 9559 9560 9561 9562 9563 9564 9565 9566 9567 9568 9569 9570 9571 9572 9573 9574 9575 9576 9577 9578 9579 9580 9581 9582 9583 9584 9585 9586 9587 9588 9589 |
# File 'lib/oci/core/virtual_network_client.rb', line 9550 def get_vcn_overlap(vcn_id, get_vcn_overlap_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_vcn_overlap.' if logger raise "Missing the required parameter 'vcn_id' when calling get_vcn_overlap." if vcn_id.nil? raise "Missing the required parameter 'get_vcn_overlap_details' when calling get_vcn_overlap." if get_vcn_overlap_details.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/ipInventory/vcns/{vcnId}/overlaps'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(get_vcn_overlap_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn_overlap') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IpInventoryVcnOverlapCollection' ) end # rubocop:enable Metrics/BlockLength end |
#get_vcn_topology(compartment_id, vcn_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_vcn_topology API.
Gets a virtual network topology for a given VCN.
9633 9634 9635 9636 9637 9638 9639 9640 9641 9642 9643 9644 9645 9646 9647 9648 9649 9650 9651 9652 9653 9654 9655 9656 9657 9658 9659 9660 9661 9662 9663 9664 9665 9666 9667 9668 9669 9670 9671 9672 9673 9674 9675 9676 9677 9678 9679 |
# File 'lib/oci/core/virtual_network_client.rb', line 9633 def get_vcn_topology(compartment_id, vcn_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_vcn_topology.' if logger raise "Missing the required parameter 'compartment_id' when calling get_vcn_topology." if compartment_id.nil? raise "Missing the required parameter 'vcn_id' when calling get_vcn_topology." if vcn_id.nil? if opts[:access_level] && !%w[ANY ACCESSIBLE].include?(opts[:access_level]) raise 'Invalid value for "access_level", must be one of ANY, ACCESSIBLE.' end path = '/vcnTopology' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:vcnId] = vcn_id query_params[:accessLevel] = opts[:access_level] if opts[:access_level] query_params[:queryCompartmentSubtree] = opts[:query_compartment_subtree] if !opts[:query_compartment_subtree].nil? # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-none-match'] = opts[:if_none_match] if opts[:if_none_match] header_params[:'cache-control'] = opts[:cache_control] if opts[:cache_control] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vcn_topology') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VcnTopology' ) end # rubocop:enable Metrics/BlockLength end |
#get_virtual_circuit(virtual_circuit_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_virtual_circuit API.
Gets the specified virtual circuit's information.
9697 9698 9699 9700 9701 9702 9703 9704 9705 9706 9707 9708 9709 9710 9711 9712 9713 9714 9715 9716 9717 9718 9719 9720 9721 9722 9723 9724 9725 9726 9727 9728 9729 9730 9731 9732 |
# File 'lib/oci/core/virtual_network_client.rb', line 9697 def get_virtual_circuit(virtual_circuit_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_virtual_circuit.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling get_virtual_circuit." if virtual_circuit_id.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_virtual_circuit') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VirtualCircuit' ) end # rubocop:enable Metrics/BlockLength end |
#get_vlan(vlan_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_vlan API.
Gets the specified VLAN's information.
9753 9754 9755 9756 9757 9758 9759 9760 9761 9762 9763 9764 9765 9766 9767 9768 9769 9770 9771 9772 9773 9774 9775 9776 9777 9778 9779 9780 9781 9782 9783 9784 9785 9786 9787 9788 9789 |
# File 'lib/oci/core/virtual_network_client.rb', line 9753 def get_vlan(vlan_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_vlan.' if logger raise "Missing the required parameter 'vlan_id' when calling get_vlan." if vlan_id.nil? raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id) path = '/vlans/{vlanId}'.sub('{vlanId}', vlan_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vlan') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vlan' ) end # rubocop:enable Metrics/BlockLength end |
#get_vnic(vnic_id, opts = {}) ⇒ Response
9811 9812 9813 9814 9815 9816 9817 9818 9819 9820 9821 9822 9823 9824 9825 9826 9827 9828 9829 9830 9831 9832 9833 9834 9835 9836 9837 9838 9839 9840 9841 9842 9843 9844 9845 9846 |
# File 'lib/oci/core/virtual_network_client.rb', line 9811 def get_vnic(vnic_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_vnic.' if logger raise "Missing the required parameter 'vnic_id' when calling get_vnic." if vnic_id.nil? raise "Parameter value for 'vnic_id' must not be blank" if OCI::Internal::Util.blank_string?(vnic_id) path = '/vnics/{vnicId}'.sub('{vnicId}', vnic_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vnic') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vnic' ) end # rubocop:enable Metrics/BlockLength end |
#get_vtap(vtap_id, opts = {}) ⇒ Response
Click here to see an example of how to use get_vtap API.
Gets the specified Vtap
resource.
9867 9868 9869 9870 9871 9872 9873 9874 9875 9876 9877 9878 9879 9880 9881 9882 9883 9884 9885 9886 9887 9888 9889 9890 9891 9892 9893 9894 9895 9896 9897 9898 9899 9900 9901 9902 9903 |
# File 'lib/oci/core/virtual_network_client.rb', line 9867 def get_vtap(vtap_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#get_vtap.' if logger raise "Missing the required parameter 'vtap_id' when calling get_vtap." if vtap_id.nil? raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id) path = '/vtaps/{vtapId}'.sub('{vtapId}', vtap_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#get_vtap') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vtap' ) end # rubocop:enable Metrics/BlockLength end |
#list_allowed_peer_regions_for_remote_peering(opts = {}) ⇒ Response
Click here to see an example of how to use list_allowed_peer_regions_for_remote_peering API.
Lists the regions that support remote VCN peering (which is peering across regions). For more information, see VCN Peering.
9922 9923 9924 9925 9926 9927 9928 9929 9930 9931 9932 9933 9934 9935 9936 9937 9938 9939 9940 9941 9942 9943 9944 9945 9946 9947 9948 9949 9950 9951 9952 9953 9954 9955 |
# File 'lib/oci/core/virtual_network_client.rb', line 9922 def list_allowed_peer_regions_for_remote_peering(opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_allowed_peer_regions_for_remote_peering.' if logger path = '/allowedPeerRegionsForRemotePeering' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_allowed_peer_regions_for_remote_peering') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::PeerRegionForRemotePeering>' ) end # rubocop:enable Metrics/BlockLength end |
#list_byoip_allocated_ranges(byoip_range_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_byoip_allocated_ranges API.
Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool. Each ByoipAllocatedRange
object also lists the IP pool where it is allocated.
9988 9989 9990 9991 9992 9993 9994 9995 9996 9997 9998 9999 10000 10001 10002 10003 10004 10005 10006 10007 10008 10009 10010 10011 10012 10013 10014 10015 10016 10017 10018 10019 10020 10021 10022 10023 10024 10025 10026 |
# File 'lib/oci/core/virtual_network_client.rb', line 9988 def list_byoip_allocated_ranges(byoip_range_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_byoip_allocated_ranges.' if logger raise "Missing the required parameter 'byoip_range_id' when calling list_byoip_allocated_ranges." if byoip_range_id.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}/byoipAllocatedRanges'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_byoip_allocated_ranges') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ByoipAllocatedRangeCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_byoip_ranges(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_byoip_ranges API.
Lists the ByoipRange
resources in the specified compartment. You can filter the list using query parameters.
10076 10077 10078 10079 10080 10081 10082 10083 10084 10085 10086 10087 10088 10089 10090 10091 10092 10093 10094 10095 10096 10097 10098 10099 10100 10101 10102 10103 10104 10105 10106 10107 10108 10109 10110 10111 10112 10113 10114 10115 10116 10117 10118 10119 10120 10121 10122 10123 10124 10125 10126 |
# File 'lib/oci/core/virtual_network_client.rb', line 10076 def list_byoip_ranges(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_byoip_ranges.' if logger raise "Missing the required parameter 'compartment_id' when calling list_byoip_ranges." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/byoipRanges' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_byoip_ranges') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ByoipRangeCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_capture_filters(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_capture_filters API.
Lists the capture filters in the specified compartment.
10177 10178 10179 10180 10181 10182 10183 10184 10185 10186 10187 10188 10189 10190 10191 10192 10193 10194 10195 10196 10197 10198 10199 10200 10201 10202 10203 10204 10205 10206 10207 10208 10209 10210 10211 10212 10213 10214 10215 10216 10217 10218 10219 10220 10221 10222 10223 10224 10225 10226 10227 10228 10229 10230 10231 10232 10233 10234 10235 10236 |
# File 'lib/oci/core/virtual_network_client.rb', line 10177 def list_capture_filters(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_capture_filters.' if logger raise "Missing the required parameter 'compartment_id' when calling list_capture_filters." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::CaptureFilter::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::CaptureFilter::LIFECYCLE_STATE_ENUM.' end if opts[:filter_type] && !OCI::Core::Models::CaptureFilter::FILTER_TYPE_ENUM.include?(opts[:filter_type]) raise 'Invalid value for "filter_type", must be one of the values in OCI::Core::Models::CaptureFilter::FILTER_TYPE_ENUM.' end path = '/captureFilters' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] query_params[:filterType] = opts[:filter_type] if opts[:filter_type] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_capture_filters') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::CaptureFilter>' ) end # rubocop:enable Metrics/BlockLength end |
#list_cpe_device_shapes(opts = {}) ⇒ Response
Click here to see an example of how to use list_cpe_device_shapes API.
Lists the CPE device types that the Networking service provides CPE configuration content for (example: Cisco ASA). The content helps a network engineer configure the actual CPE device represented by a Cpe object.
If you want to generate CPE configuration content for one of the returned CPE device types, ensure that the Cpe} object’s cpeDeviceShapeId attribute is set to the CPE device type’s (returned by this operation).
For information about generating CPE configuration content, see these operations:
-
{#get_cpe_device_config_content get_cpe_device_config_content
10278 10279 10280 10281 10282 10283 10284 10285 10286 10287 10288 10289 10290 10291 10292 10293 10294 10295 10296 10297 10298 10299 10300 10301 10302 10303 10304 10305 10306 10307 10308 10309 10310 10311 10312 10313 10314 |
# File 'lib/oci/core/virtual_network_client.rb', line 10278 def list_cpe_device_shapes(opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_cpe_device_shapes.' if logger path = '/cpeDeviceShapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cpe_device_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::CpeDeviceShapeSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_cpes(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_cpes API.
Lists the customer-premises equipment objects (CPEs) in the specified compartment.
10342 10343 10344 10345 10346 10347 10348 10349 10350 10351 10352 10353 10354 10355 10356 10357 10358 10359 10360 10361 10362 10363 10364 10365 10366 10367 10368 10369 10370 10371 10372 10373 10374 10375 10376 10377 10378 10379 |
# File 'lib/oci/core/virtual_network_client.rb', line 10342 def list_cpes(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_cpes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_cpes." if compartment_id.nil? path = '/cpes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cpes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Cpe>' ) end # rubocop:enable Metrics/BlockLength end |
#list_cross_connect_groups(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_cross_connect_groups API.
Lists the cross-connect groups in the specified compartment.
10426 10427 10428 10429 10430 10431 10432 10433 10434 10435 10436 10437 10438 10439 10440 10441 10442 10443 10444 10445 10446 10447 10448 10449 10450 10451 10452 10453 10454 10455 10456 10457 10458 10459 10460 10461 10462 10463 10464 10465 10466 10467 10468 10469 10470 10471 10472 10473 10474 10475 10476 10477 10478 10479 |
# File 'lib/oci/core/virtual_network_client.rb', line 10426 def list_cross_connect_groups(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_cross_connect_groups.' if logger raise "Missing the required parameter 'compartment_id' when calling list_cross_connect_groups." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::CrossConnectGroup::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::CrossConnectGroup::LIFECYCLE_STATE_ENUM.' end path = '/crossConnectGroups' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connect_groups') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::CrossConnectGroup>' ) end # rubocop:enable Metrics/BlockLength end |
#list_cross_connect_locations(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_cross_connect_locations API.
Lists the available FastConnect locations for cross-connect installation. You need this information so you can specify your desired location when you create a cross-connect.
10508 10509 10510 10511 10512 10513 10514 10515 10516 10517 10518 10519 10520 10521 10522 10523 10524 10525 10526 10527 10528 10529 10530 10531 10532 10533 10534 10535 10536 10537 10538 10539 10540 10541 10542 10543 10544 10545 |
# File 'lib/oci/core/virtual_network_client.rb', line 10508 def list_cross_connect_locations(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_cross_connect_locations.' if logger raise "Missing the required parameter 'compartment_id' when calling list_cross_connect_locations." if compartment_id.nil? path = '/crossConnectLocations' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connect_locations') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::CrossConnectLocation>' ) end # rubocop:enable Metrics/BlockLength end |
#list_cross_connect_mappings(virtual_circuit_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_cross_connect_mappings API.
Lists the Cross Connect mapping Details for the specified virtual circuit.
10567 10568 10569 10570 10571 10572 10573 10574 10575 10576 10577 10578 10579 10580 10581 10582 10583 10584 10585 10586 10587 10588 10589 10590 10591 10592 10593 10594 10595 10596 10597 10598 10599 10600 10601 10602 10603 |
# File 'lib/oci/core/virtual_network_client.rb', line 10567 def list_cross_connect_mappings(virtual_circuit_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_cross_connect_mappings.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling list_cross_connect_mappings." if virtual_circuit_id.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}/crossConnectMappings'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connect_mappings') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnectMappingDetailsCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_cross_connects(compartment_id, opts = {}) ⇒ Response
10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 |
# File 'lib/oci/core/virtual_network_client.rb', line 10652 def list_cross_connects(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_cross_connects.' if logger raise "Missing the required parameter 'compartment_id' when calling list_cross_connects." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::CrossConnect::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::CrossConnect::LIFECYCLE_STATE_ENUM.' end path = '/crossConnects' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:crossConnectGroupId] = opts[:cross_connect_group_id] if opts[:cross_connect_group_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_cross_connects') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::CrossConnect>' ) end # rubocop:enable Metrics/BlockLength end |
#list_crossconnect_port_speed_shapes(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_crossconnect_port_speed_shapes API.
Lists the available port speeds for cross-connects. You need this information so you can specify your desired port speed (that is, shape) when you create a cross-connect.
10736 10737 10738 10739 10740 10741 10742 10743 10744 10745 10746 10747 10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 10758 10759 10760 10761 10762 10763 10764 10765 10766 10767 10768 10769 10770 10771 10772 10773 |
# File 'lib/oci/core/virtual_network_client.rb', line 10736 def list_crossconnect_port_speed_shapes(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_crossconnect_port_speed_shapes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_crossconnect_port_speed_shapes." if compartment_id.nil? path = '/crossConnectPortSpeedShapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_crossconnect_port_speed_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::CrossConnectPortSpeedShape>' ) end # rubocop:enable Metrics/BlockLength end |
#list_dhcp_options(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_dhcp_options API.
Lists the sets of DHCP options in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the sets of DHCP options from all VCNs in the specified compartment. The response includes the default set of options that automatically comes with each VCN, plus any other sets you've created.
10824 10825 10826 10827 10828 10829 10830 10831 10832 10833 10834 10835 10836 10837 10838 10839 10840 10841 10842 10843 10844 10845 10846 10847 10848 10849 10850 10851 10852 10853 10854 10855 10856 10857 10858 10859 10860 10861 10862 10863 10864 10865 10866 10867 10868 10869 10870 10871 10872 10873 10874 10875 10876 10877 10878 |
# File 'lib/oci/core/virtual_network_client.rb', line 10824 def (compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_dhcp_options.' if logger raise "Missing the required parameter 'compartment_id' when calling list_dhcp_options." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::DhcpOptions::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DhcpOptions::LIFECYCLE_STATE_ENUM.' end path = '/dhcps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_dhcp_options') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DhcpOptions>' ) end # rubocop:enable Metrics/BlockLength end |
#list_drg_attachments(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_drg_attachments API.
Lists the DrgAttachment
resource for the specified compartment. You can filter the results by DRG, attached network, attachment type, DRG route table or VCN route table.
The LIST API lists DRG attachments by attachment type. It will default to list VCN attachments, but you may request to list ALL attachments of ALL types.
10936 10937 10938 10939 10940 10941 10942 10943 10944 10945 10946 10947 10948 10949 10950 10951 10952 10953 10954 10955 10956 10957 10958 10959 10960 10961 10962 10963 10964 10965 10966 10967 10968 10969 10970 10971 10972 10973 10974 10975 10976 10977 10978 10979 10980 10981 10982 10983 10984 10985 10986 10987 10988 10989 10990 10991 10992 10993 10994 10995 10996 10997 10998 |
# File 'lib/oci/core/virtual_network_client.rb', line 10936 def (compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_drg_attachments.' if logger raise "Missing the required parameter 'compartment_id' when calling list_drg_attachments." if compartment_id.nil? if opts[:attachment_type] && !%w[VCN VIRTUAL_CIRCUIT REMOTE_PEERING_CONNECTION IPSEC_TUNNEL ALL].include?(opts[:attachment_type]) raise 'Invalid value for "attachment_type", must be one of VCN, VIRTUAL_CIRCUIT, REMOTE_PEERING_CONNECTION, IPSEC_TUNNEL, ALL.' end if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::DrgAttachment::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DrgAttachment::LIFECYCLE_STATE_ENUM.' end path = '/drgAttachments' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:drgId] = opts[:drg_id] if opts[:drg_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:networkId] = opts[:network_id] if opts[:network_id] query_params[:attachmentType] = opts[:attachment_type] if opts[:attachment_type] query_params[:drgRouteTableId] = opts[:drg_route_table_id] if opts[:drg_route_table_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_attachments') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgAttachment>' ) end # rubocop:enable Metrics/BlockLength end |
#list_drg_route_distribution_statements(drg_route_distribution_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_drg_route_distribution_statements API.
Lists the statements for the specified route distribution.
11031 11032 11033 11034 11035 11036 11037 11038 11039 11040 11041 11042 11043 11044 11045 11046 11047 11048 11049 11050 11051 11052 11053 11054 11055 11056 11057 11058 11059 11060 11061 11062 11063 11064 11065 11066 11067 11068 11069 11070 11071 11072 11073 11074 11075 11076 11077 11078 |
# File 'lib/oci/core/virtual_network_client.rb', line 11031 def list_drg_route_distribution_statements(drg_route_distribution_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_distribution_statements.' if logger raise "Missing the required parameter 'drg_route_distribution_id' when calling list_drg_route_distribution_statements." if drg_route_distribution_id.nil? if opts[:sort_by] && !%w[TIMECREATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id) path = '/drgRouteDistributions/{drgRouteDistributionId}/drgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_distribution_statements') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteDistributionStatement>' ) end # rubocop:enable Metrics/BlockLength end |
#list_drg_route_distributions(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_drg_route_distributions API.
Lists the route distributions in the specified DRG.
To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation.
11128 11129 11130 11131 11132 11133 11134 11135 11136 11137 11138 11139 11140 11141 11142 11143 11144 11145 11146 11147 11148 11149 11150 11151 11152 11153 11154 11155 11156 11157 11158 11159 11160 11161 11162 11163 11164 11165 11166 11167 11168 11169 11170 11171 11172 11173 11174 11175 11176 11177 11178 11179 11180 11181 |
# File 'lib/oci/core/virtual_network_client.rb', line 11128 def list_drg_route_distributions(drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_distributions.' if logger raise "Missing the required parameter 'drg_id' when calling list_drg_route_distributions." if drg_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::DrgRouteDistribution::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DrgRouteDistribution::LIFECYCLE_STATE_ENUM.' end path = '/drgRouteDistributions' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:drgId] = drg_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_distributions') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteDistribution>' ) end # rubocop:enable Metrics/BlockLength end |
#list_drg_route_rules(drg_route_table_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_drg_route_rules API.
Lists the route rules in the specified DRG route table.
11212 11213 11214 11215 11216 11217 11218 11219 11220 11221 11222 11223 11224 11225 11226 11227 11228 11229 11230 11231 11232 11233 11234 11235 11236 11237 11238 11239 11240 11241 11242 11243 11244 11245 11246 11247 11248 11249 11250 11251 11252 11253 11254 |
# File 'lib/oci/core/virtual_network_client.rb', line 11212 def list_drg_route_rules(drg_route_table_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_rules.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling list_drg_route_rules." if drg_route_table_id.nil? if opts[:route_type] && !%w[STATIC DYNAMIC].include?(opts[:route_type]) raise 'Invalid value for "route_type", must be one of STATIC, DYNAMIC.' end raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}/drgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:routeType] = opts[:route_type] if opts[:route_type] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_rules') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteRule>' ) end # rubocop:enable Metrics/BlockLength end |
#list_drg_route_tables(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_drg_route_tables API.
Lists the DRG route tables for the specified DRG.
Use the ListDrgRouteRules
operation to retrieve the route rules in a table.
11305 11306 11307 11308 11309 11310 11311 11312 11313 11314 11315 11316 11317 11318 11319 11320 11321 11322 11323 11324 11325 11326 11327 11328 11329 11330 11331 11332 11333 11334 11335 11336 11337 11338 11339 11340 11341 11342 11343 11344 11345 11346 11347 11348 11349 11350 11351 11352 11353 11354 11355 11356 11357 11358 11359 |
# File 'lib/oci/core/virtual_network_client.rb', line 11305 def list_drg_route_tables(drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_drg_route_tables.' if logger raise "Missing the required parameter 'drg_id' when calling list_drg_route_tables." if drg_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::DrgRouteTable::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::DrgRouteTable::LIFECYCLE_STATE_ENUM.' end path = '/drgRouteTables' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:drgId] = drg_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:importDrgRouteDistributionId] = opts[:import_drg_route_distribution_id] if opts[:import_drg_route_distribution_id] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drg_route_tables') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteTable>' ) end # rubocop:enable Metrics/BlockLength end |
#list_drgs(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_drgs API.
Lists the DRGs in the specified compartment.
11387 11388 11389 11390 11391 11392 11393 11394 11395 11396 11397 11398 11399 11400 11401 11402 11403 11404 11405 11406 11407 11408 11409 11410 11411 11412 11413 11414 11415 11416 11417 11418 11419 11420 11421 11422 11423 11424 |
# File 'lib/oci/core/virtual_network_client.rb', line 11387 def list_drgs(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_drgs.' if logger raise "Missing the required parameter 'compartment_id' when calling list_drgs." if compartment_id.nil? path = '/drgs' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_drgs') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Drg>' ) end # rubocop:enable Metrics/BlockLength end |
#list_fast_connect_provider_services(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_fast_connect_provider_services API.
Lists the service offerings from supported providers. You need this information so you can specify your desired provider and service offering when you create a virtual circuit.
For the compartment ID, provide the OCID of your tenancy (the root compartment).
For more information, see FastConnect Overview.
11458 11459 11460 11461 11462 11463 11464 11465 11466 11467 11468 11469 11470 11471 11472 11473 11474 11475 11476 11477 11478 11479 11480 11481 11482 11483 11484 11485 11486 11487 11488 11489 11490 11491 11492 11493 11494 11495 |
# File 'lib/oci/core/virtual_network_client.rb', line 11458 def list_fast_connect_provider_services(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_fast_connect_provider_services.' if logger raise "Missing the required parameter 'compartment_id' when calling list_fast_connect_provider_services." if compartment_id.nil? path = '/fastConnectProviderServices' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_fast_connect_provider_services') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::FastConnectProviderService>' ) end # rubocop:enable Metrics/BlockLength end |
#list_fast_connect_provider_virtual_circuit_bandwidth_shapes(provider_service_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_fast_connect_provider_virtual_circuit_bandwidth_shapes API.
Gets the list of available virtual circuit bandwidth levels for a provider. You need this information so you can specify your desired bandwidth level (shape) when you create a virtual circuit.
For more information about virtual circuits, see FastConnect Overview.
11526 11527 11528 11529 11530 11531 11532 11533 11534 11535 11536 11537 11538 11539 11540 11541 11542 11543 11544 11545 11546 11547 11548 11549 11550 11551 11552 11553 11554 11555 11556 11557 11558 11559 11560 11561 11562 11563 |
# File 'lib/oci/core/virtual_network_client.rb', line 11526 def list_fast_connect_provider_virtual_circuit_bandwidth_shapes(provider_service_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_fast_connect_provider_virtual_circuit_bandwidth_shapes.' if logger raise "Missing the required parameter 'provider_service_id' when calling list_fast_connect_provider_virtual_circuit_bandwidth_shapes." if provider_service_id.nil? raise "Parameter value for 'provider_service_id' must not be blank" if OCI::Internal::Util.blank_string?(provider_service_id) path = '/fastConnectProviderServices/{providerServiceId}/virtualCircuitBandwidthShapes'.sub('{providerServiceId}', provider_service_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_fast_connect_provider_virtual_circuit_bandwidth_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::VirtualCircuitBandwidthShape>' ) end # rubocop:enable Metrics/BlockLength end |
#list_internet_gateways(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_internet_gateways API.
Lists the internet gateways in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the internet gateways from all VCNs in the specified compartment.
11612 11613 11614 11615 11616 11617 11618 11619 11620 11621 11622 11623 11624 11625 11626 11627 11628 11629 11630 11631 11632 11633 11634 11635 11636 11637 11638 11639 11640 11641 11642 11643 11644 11645 11646 11647 11648 11649 11650 11651 11652 11653 11654 11655 11656 11657 11658 11659 11660 11661 11662 11663 11664 11665 11666 |
# File 'lib/oci/core/virtual_network_client.rb', line 11612 def list_internet_gateways(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_internet_gateways.' if logger raise "Missing the required parameter 'compartment_id' when calling list_internet_gateways." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::InternetGateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::InternetGateway::LIFECYCLE_STATE_ENUM.' end path = '/internetGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_internet_gateways') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::InternetGateway>' ) end # rubocop:enable Metrics/BlockLength end |
#list_ip_inventory(list_ip_inventory_details, opts = {}) ⇒ Response
Click here to see an example of how to use list_ip_inventory API.
Lists the IP Inventory information in the selected compartments.
11687 11688 11689 11690 11691 11692 11693 11694 11695 11696 11697 11698 11699 11700 11701 11702 11703 11704 11705 11706 11707 11708 11709 11710 11711 11712 11713 11714 11715 11716 11717 11718 11719 11720 11721 11722 |
# File 'lib/oci/core/virtual_network_client.rb', line 11687 def list_ip_inventory(list_ip_inventory_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_ip_inventory.' if logger raise "Missing the required parameter 'list_ip_inventory_details' when calling list_ip_inventory." if list_ip_inventory_details.nil? path = '/ipInventory' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(list_ip_inventory_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_inventory') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IpInventoryCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_ip_sec_connection_tunnel_routes(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_ip_sec_connection_tunnel_routes API.
The routes advertised to the on-premises network and the routes received from the on-premises network.
11755 11756 11757 11758 11759 11760 11761 11762 11763 11764 11765 11766 11767 11768 11769 11770 11771 11772 11773 11774 11775 11776 11777 11778 11779 11780 11781 11782 11783 11784 11785 11786 11787 11788 11789 11790 11791 11792 11793 11794 11795 11796 11797 11798 11799 |
# File 'lib/oci/core/virtual_network_client.rb', line 11755 def list_ip_sec_connection_tunnel_routes(ipsc_id, tunnel_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connection_tunnel_routes.' if logger raise "Missing the required parameter 'ipsc_id' when calling list_ip_sec_connection_tunnel_routes." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling list_ip_sec_connection_tunnel_routes." if tunnel_id.nil? if opts[:advertiser] && !OCI::Core::Models::TunnelRouteSummary::ADVERTISER_ENUM.include?(opts[:advertiser]) raise 'Invalid value for "advertiser", must be one of the values in OCI::Core::Models::TunnelRouteSummary::ADVERTISER_ENUM.' end raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/routes'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:advertiser] = opts[:advertiser] if opts[:advertiser] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connection_tunnel_routes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::TunnelRouteSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_ip_sec_connection_tunnel_security_associations(ipsc_id, tunnel_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_ip_sec_connection_tunnel_security_associations API.
Lists the tunnel security associations information for the specified IPSec tunnel ID.
11828 11829 11830 11831 11832 11833 11834 11835 11836 11837 11838 11839 11840 11841 11842 11843 11844 11845 11846 11847 11848 11849 11850 11851 11852 11853 11854 11855 11856 11857 11858 11859 11860 11861 11862 11863 11864 11865 11866 11867 |
# File 'lib/oci/core/virtual_network_client.rb', line 11828 def list_ip_sec_connection_tunnel_security_associations(ipsc_id, tunnel_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connection_tunnel_security_associations.' if logger raise "Missing the required parameter 'ipsc_id' when calling list_ip_sec_connection_tunnel_security_associations." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling list_ip_sec_connection_tunnel_security_associations." if tunnel_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelSecurityAssociations'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connection_tunnel_security_associations') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::TunnelSecurityAssociationSummary>' ) end # rubocop:enable Metrics/BlockLength end |
#list_ip_sec_connection_tunnels(ipsc_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_ip_sec_connection_tunnels API.
Lists the tunnel information for the specified IPSec connection.
11895 11896 11897 11898 11899 11900 11901 11902 11903 11904 11905 11906 11907 11908 11909 11910 11911 11912 11913 11914 11915 11916 11917 11918 11919 11920 11921 11922 11923 11924 11925 11926 11927 11928 11929 11930 11931 11932 |
# File 'lib/oci/core/virtual_network_client.rb', line 11895 def list_ip_sec_connection_tunnels(ipsc_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connection_tunnels.' if logger raise "Missing the required parameter 'ipsc_id' when calling list_ip_sec_connection_tunnels." if ipsc_id.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}/tunnels'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connection_tunnels') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::IPSecConnectionTunnel>' ) end # rubocop:enable Metrics/BlockLength end |
#list_ip_sec_connections(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_ip_sec_connections API.
Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.
11963 11964 11965 11966 11967 11968 11969 11970 11971 11972 11973 11974 11975 11976 11977 11978 11979 11980 11981 11982 11983 11984 11985 11986 11987 11988 11989 11990 11991 11992 11993 11994 11995 11996 11997 11998 11999 12000 12001 12002 |
# File 'lib/oci/core/virtual_network_client.rb', line 11963 def list_ip_sec_connections(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_ip_sec_connections.' if logger raise "Missing the required parameter 'compartment_id' when calling list_ip_sec_connections." if compartment_id.nil? path = '/ipsecConnections' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:drgId] = opts[:drg_id] if opts[:drg_id] query_params[:cpeId] = opts[:cpe_id] if opts[:cpe_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ip_sec_connections') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::IPSecConnection>' ) end # rubocop:enable Metrics/BlockLength end |
#list_ipv6s(opts = {}) ⇒ Response
Click here to see an example of how to use list_ipv6s API.
Lists the Ipv6 objects based on one of these filters:
-
Subnet OCID.
-
VNIC OCID.
-
Both IPv6 address and subnet OCID: This lets you get an
Ipv6
object based on its private IPv6 address (for example, 2001:0db8:0123:1111:abcd:ef01:2345:6789) and not its OCID. For comparison, #get_ipv6 get_ipv6} requires the {OCID.
12044 12045 12046 12047 12048 12049 12050 12051 12052 12053 12054 12055 12056 12057 12058 12059 12060 12061 12062 12063 12064 12065 12066 12067 12068 12069 12070 12071 12072 12073 12074 12075 12076 12077 12078 12079 12080 12081 12082 12083 |
# File 'lib/oci/core/virtual_network_client.rb', line 12044 def list_ipv6s(opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_ipv6s.' if logger path = '/ipv6' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:ipAddress] = opts[:ip_address] if opts[:ip_address] query_params[:subnetId] = opts[:subnet_id] if opts[:subnet_id] query_params[:vnicId] = opts[:vnic_id] if opts[:vnic_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_ipv6s') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Ipv6>' ) end # rubocop:enable Metrics/BlockLength end |
#list_local_peering_gateways(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_local_peering_gateways API.
Lists the local peering gateways (LPGs) for the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the LPGs from all VCNs in the specified compartment.
12113 12114 12115 12116 12117 12118 12119 12120 12121 12122 12123 12124 12125 12126 12127 12128 12129 12130 12131 12132 12133 12134 12135 12136 12137 12138 12139 12140 12141 12142 12143 12144 12145 12146 12147 12148 12149 12150 12151 |
# File 'lib/oci/core/virtual_network_client.rb', line 12113 def list_local_peering_gateways(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_local_peering_gateways.' if logger raise "Missing the required parameter 'compartment_id' when calling list_local_peering_gateways." if compartment_id.nil? path = '/localPeeringGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_local_peering_gateways') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::LocalPeeringGateway>' ) end # rubocop:enable Metrics/BlockLength end |
#list_nat_gateways(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_nat_gateways API.
Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.
12200 12201 12202 12203 12204 12205 12206 12207 12208 12209 12210 12211 12212 12213 12214 12215 12216 12217 12218 12219 12220 12221 12222 12223 12224 12225 12226 12227 12228 12229 12230 12231 12232 12233 12234 12235 12236 12237 12238 12239 12240 12241 12242 12243 12244 12245 12246 12247 12248 12249 12250 12251 12252 12253 12254 |
# File 'lib/oci/core/virtual_network_client.rb', line 12200 def list_nat_gateways(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_nat_gateways.' if logger raise "Missing the required parameter 'compartment_id' when calling list_nat_gateways." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::NatGateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::NatGateway::LIFECYCLE_STATE_ENUM.' end path = '/natGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_nat_gateways') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::NatGateway>' ) end # rubocop:enable Metrics/BlockLength end |
#list_network_security_group_security_rules(network_security_group_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_network_security_group_security_rules API.
Lists the security rules in the specified network security group.
12292 12293 12294 12295 12296 12297 12298 12299 12300 12301 12302 12303 12304 12305 12306 12307 12308 12309 12310 12311 12312 12313 12314 12315 12316 12317 12318 12319 12320 12321 12322 12323 12324 12325 12326 12327 12328 12329 12330 12331 12332 12333 12334 12335 12336 12337 12338 12339 12340 12341 12342 12343 12344 |
# File 'lib/oci/core/virtual_network_client.rb', line 12292 def list_network_security_group_security_rules(network_security_group_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_network_security_group_security_rules.' if logger raise "Missing the required parameter 'network_security_group_id' when calling list_network_security_group_security_rules." if network_security_group_id.nil? if opts[:direction] && !%w[EGRESS INGRESS].include?(opts[:direction]) raise 'Invalid value for "direction", must be one of EGRESS, INGRESS.' end if opts[:sort_by] && !%w[TIMECREATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}/securityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:direction] = opts[:direction] if opts[:direction] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_network_security_group_security_rules') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::SecurityRule>' ) end # rubocop:enable Metrics/BlockLength end |
#list_network_security_group_vnics(network_security_group_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_network_security_group_vnics API.
Lists the VNICs in the specified network security group.
12378 12379 12380 12381 12382 12383 12384 12385 12386 12387 12388 12389 12390 12391 12392 12393 12394 12395 12396 12397 12398 12399 12400 12401 12402 12403 12404 12405 12406 12407 12408 12409 12410 12411 12412 12413 12414 12415 12416 12417 12418 12419 12420 12421 12422 12423 12424 12425 |
# File 'lib/oci/core/virtual_network_client.rb', line 12378 def list_network_security_group_vnics(network_security_group_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_network_security_group_vnics.' if logger raise "Missing the required parameter 'network_security_group_id' when calling list_network_security_group_vnics." if network_security_group_id.nil? if opts[:sort_by] && !%w[TIMEASSOCIATED].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMEASSOCIATED.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}/vnics'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_network_security_group_vnics') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::NetworkSecurityGroupVnic>' ) end # rubocop:enable Metrics/BlockLength end |
#list_network_security_groups(opts = {}) ⇒ Response
Click here to see an example of how to use list_network_security_groups API.
Lists either the network security groups in the specified compartment, or those associated with the specified VLAN. You must specify either a vlanId
or a compartmentId
, but not both. If you specify a vlanId
, all other parameters are ignored.
12475 12476 12477 12478 12479 12480 12481 12482 12483 12484 12485 12486 12487 12488 12489 12490 12491 12492 12493 12494 12495 12496 12497 12498 12499 12500 12501 12502 12503 12504 12505 12506 12507 12508 12509 12510 12511 12512 12513 12514 12515 12516 12517 12518 12519 12520 12521 12522 12523 12524 12525 12526 12527 12528 12529 |
# File 'lib/oci/core/virtual_network_client.rb', line 12475 def list_network_security_groups(opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_network_security_groups.' if logger if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::NetworkSecurityGroup::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::NetworkSecurityGroup::LIFECYCLE_STATE_ENUM.' end path = '/networkSecurityGroups' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = opts[:compartment_id] if opts[:compartment_id] query_params[:vlanId] = opts[:vlan_id] if opts[:vlan_id] query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_network_security_groups') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::NetworkSecurityGroup>' ) end # rubocop:enable Metrics/BlockLength end |
#list_private_ips(opts = {}) ⇒ Response
Click here to see an example of how to use list_private_ips API.
Lists the PrivateIp objects based on one of these filters:
-
Subnet OCID.
-
VNIC OCID.
-
Both private IP address and subnet OCID: This lets you get a
privateIP
object based on its private IP address (for example, 10.0.3.3) and not its OCID. For comparison, #get_private_ip get_private_ip} requires the
If you're listing all the private IPs associated with a given subnet or VNIC, the response includes both primary and secondary private IPs.
If you are an Oracle Cloud VMware Solution customer and have VLANs in your VCN, you can filter the list by VLAN OCID. See {Vlan.
12577 12578 12579 12580 12581 12582 12583 12584 12585 12586 12587 12588 12589 12590 12591 12592 12593 12594 12595 12596 12597 12598 12599 12600 12601 12602 12603 12604 12605 12606 12607 12608 12609 12610 12611 12612 12613 12614 12615 12616 |
# File 'lib/oci/core/virtual_network_client.rb', line 12577 def list_private_ips(opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_private_ips.' if logger path = '/privateIps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:ipAddress] = opts[:ip_address] if opts[:ip_address] query_params[:subnetId] = opts[:subnet_id] if opts[:subnet_id] query_params[:vnicId] = opts[:vnic_id] if opts[:vnic_id] query_params[:vlanId] = opts[:vlan_id] if opts[:vlan_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_private_ips') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::PrivateIp>' ) end # rubocop:enable Metrics/BlockLength end |
#list_public_ip_pools(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_public_ip_pools API.
Lists the public IP pools in the specified compartment. You can filter the list using query parameters.
12666 12667 12668 12669 12670 12671 12672 12673 12674 12675 12676 12677 12678 12679 12680 12681 12682 12683 12684 12685 12686 12687 12688 12689 12690 12691 12692 12693 12694 12695 12696 12697 12698 12699 12700 12701 12702 12703 12704 12705 12706 12707 12708 12709 12710 12711 12712 12713 12714 12715 12716 |
# File 'lib/oci/core/virtual_network_client.rb', line 12666 def list_public_ip_pools(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_public_ip_pools.' if logger raise "Missing the required parameter 'compartment_id' when calling list_public_ip_pools." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end path = '/publicIpPools' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:byoipRangeId] = opts[:byoip_range_id] if opts[:byoip_range_id] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_public_ip_pools') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIpPoolCollection' ) end # rubocop:enable Metrics/BlockLength end |
#list_public_ips(scope, compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_public_ips API.
Lists the PublicIp objects in the specified compartment. You can filter the list by using query parameters.
To list your reserved public IPs: * Set scope
= REGION
(required) * Leave the availabilityDomain
parameter empty * Set lifetime
= RESERVED
To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway: * Set scope
= REGION
(required) * Leave the availabilityDomain
parameter empty * Set lifetime
= EPHEMERAL
To list the ephemeral public IPs assigned to private IPs: * Set scope
= AVAILABILITY_DOMAIN
(required) * Set the availabilityDomain
parameter to the desired availability domain (required) * Set lifetime
= EPHEMERAL
Note: An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.
12784 12785 12786 12787 12788 12789 12790 12791 12792 12793 12794 12795 12796 12797 12798 12799 12800 12801 12802 12803 12804 12805 12806 12807 12808 12809 12810 12811 12812 12813 12814 12815 12816 12817 12818 12819 12820 12821 12822 12823 12824 12825 12826 12827 12828 12829 12830 12831 12832 12833 |
# File 'lib/oci/core/virtual_network_client.rb', line 12784 def list_public_ips(scope, compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_public_ips.' if logger raise "Missing the required parameter 'scope' when calling list_public_ips." if scope.nil? unless %w[REGION AVAILABILITY_DOMAIN].include?(scope) raise "Invalid value for 'scope', must be one of REGION, AVAILABILITY_DOMAIN." end raise "Missing the required parameter 'compartment_id' when calling list_public_ips." if compartment_id.nil? if opts[:lifetime] && !%w[EPHEMERAL RESERVED].include?(opts[:lifetime]) raise 'Invalid value for "lifetime", must be one of EPHEMERAL, RESERVED.' end path = '/publicIps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:scope] = scope query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:availabilityDomain] = opts[:availability_domain] if opts[:availability_domain] query_params[:lifetime] = opts[:lifetime] if opts[:lifetime] query_params[:publicIpPoolId] = opts[:public_ip_pool_id] if opts[:public_ip_pool_id] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_public_ips') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::PublicIp>' ) end # rubocop:enable Metrics/BlockLength end |
#list_remote_peering_connections(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_remote_peering_connections API.
Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC's compartment).
12863 12864 12865 12866 12867 12868 12869 12870 12871 12872 12873 12874 12875 12876 12877 12878 12879 12880 12881 12882 12883 12884 12885 12886 12887 12888 12889 12890 12891 12892 12893 12894 12895 12896 12897 12898 12899 12900 12901 |
# File 'lib/oci/core/virtual_network_client.rb', line 12863 def list_remote_peering_connections(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_remote_peering_connections.' if logger raise "Missing the required parameter 'compartment_id' when calling list_remote_peering_connections." if compartment_id.nil? path = '/remotePeeringConnections' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:drgId] = opts[:drg_id] if opts[:drg_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_remote_peering_connections') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::RemotePeeringConnection>' ) end # rubocop:enable Metrics/BlockLength end |
#list_route_tables(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_route_tables API.
Lists the route tables in the specified VCN and specified compartment. If the VCN ID is not provided, then the list includes the route tables from all VCNs in the specified compartment. The response includes the default route table that automatically comes with each VCN in the specified compartment, plus any route tables you've created.
12952 12953 12954 12955 12956 12957 12958 12959 12960 12961 12962 12963 12964 12965 12966 12967 12968 12969 12970 12971 12972 12973 12974 12975 12976 12977 12978 12979 12980 12981 12982 12983 12984 12985 12986 12987 12988 12989 12990 12991 12992 12993 12994 12995 12996 12997 12998 12999 13000 13001 13002 13003 13004 13005 13006 |
# File 'lib/oci/core/virtual_network_client.rb', line 12952 def list_route_tables(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_route_tables.' if logger raise "Missing the required parameter 'compartment_id' when calling list_route_tables." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::RouteTable::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::RouteTable::LIFECYCLE_STATE_ENUM.' end path = '/routeTables' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_route_tables') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::RouteTable>' ) end # rubocop:enable Metrics/BlockLength end |
#list_security_lists(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_security_lists API.
Lists the security lists in the specified VCN and compartment. If the VCN ID is not provided, then the list includes the security lists from all VCNs in the specified compartment.
13055 13056 13057 13058 13059 13060 13061 13062 13063 13064 13065 13066 13067 13068 13069 13070 13071 13072 13073 13074 13075 13076 13077 13078 13079 13080 13081 13082 13083 13084 13085 13086 13087 13088 13089 13090 13091 13092 13093 13094 13095 13096 13097 13098 13099 13100 13101 13102 13103 13104 13105 13106 13107 13108 13109 |
# File 'lib/oci/core/virtual_network_client.rb', line 13055 def list_security_lists(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_security_lists.' if logger raise "Missing the required parameter 'compartment_id' when calling list_security_lists." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::SecurityList::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::SecurityList::LIFECYCLE_STATE_ENUM.' end path = '/securityLists' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_security_lists') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::SecurityList>' ) end # rubocop:enable Metrics/BlockLength end |
#list_service_gateways(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_service_gateways API.
Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.
13156 13157 13158 13159 13160 13161 13162 13163 13164 13165 13166 13167 13168 13169 13170 13171 13172 13173 13174 13175 13176 13177 13178 13179 13180 13181 13182 13183 13184 13185 13186 13187 13188 13189 13190 13191 13192 13193 13194 13195 13196 13197 13198 13199 13200 13201 13202 13203 13204 13205 13206 13207 13208 13209 |
# File 'lib/oci/core/virtual_network_client.rb', line 13156 def list_service_gateways(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_service_gateways.' if logger raise "Missing the required parameter 'compartment_id' when calling list_service_gateways." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::ServiceGateway::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::ServiceGateway::LIFECYCLE_STATE_ENUM.' end path = '/serviceGateways' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_service_gateways') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::ServiceGateway>' ) end # rubocop:enable Metrics/BlockLength end |
#list_services(opts = {}) ⇒ Response
Click here to see an example of how to use list_services API.
Lists the available Service objects that you can enable for a service gateway in this region.
13237 13238 13239 13240 13241 13242 13243 13244 13245 13246 13247 13248 13249 13250 13251 13252 13253 13254 13255 13256 13257 13258 13259 13260 13261 13262 13263 13264 13265 13266 13267 13268 13269 13270 13271 13272 |
# File 'lib/oci/core/virtual_network_client.rb', line 13237 def list_services(opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_services.' if logger path = '/services' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_services') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Service>' ) end # rubocop:enable Metrics/BlockLength end |
#list_subnets(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_subnets API.
Lists the subnets in the specified VCN and the specified compartment. If the VCN ID is not provided, then the list includes the subnets from all VCNs in the specified compartment.
13321 13322 13323 13324 13325 13326 13327 13328 13329 13330 13331 13332 13333 13334 13335 13336 13337 13338 13339 13340 13341 13342 13343 13344 13345 13346 13347 13348 13349 13350 13351 13352 13353 13354 13355 13356 13357 13358 13359 13360 13361 13362 13363 13364 13365 13366 13367 13368 13369 13370 13371 13372 13373 13374 13375 |
# File 'lib/oci/core/virtual_network_client.rb', line 13321 def list_subnets(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_subnets.' if logger raise "Missing the required parameter 'compartment_id' when calling list_subnets." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::Subnet::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Subnet::LIFECYCLE_STATE_ENUM.' end path = '/subnets' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_subnets') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Subnet>' ) end # rubocop:enable Metrics/BlockLength end |
#list_vcns(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_vcns API.
Lists the virtual cloud networks (VCNs) in the specified compartment.
13422 13423 13424 13425 13426 13427 13428 13429 13430 13431 13432 13433 13434 13435 13436 13437 13438 13439 13440 13441 13442 13443 13444 13445 13446 13447 13448 13449 13450 13451 13452 13453 13454 13455 13456 13457 13458 13459 13460 13461 13462 13463 13464 13465 13466 13467 13468 13469 13470 13471 13472 13473 13474 13475 |
# File 'lib/oci/core/virtual_network_client.rb', line 13422 def list_vcns(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_vcns.' if logger raise "Missing the required parameter 'compartment_id' when calling list_vcns." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::Vcn::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Vcn::LIFECYCLE_STATE_ENUM.' end path = '/vcns' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_vcns') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Vcn>' ) end # rubocop:enable Metrics/BlockLength end |
#list_virtual_circuit_associated_tunnels(virtual_circuit_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_virtual_circuit_associated_tunnels API.
Gets the specified virtual circuit's associatedTunnelsInfo.
13502 13503 13504 13505 13506 13507 13508 13509 13510 13511 13512 13513 13514 13515 13516 13517 13518 13519 13520 13521 13522 13523 13524 13525 13526 13527 13528 13529 13530 13531 13532 13533 13534 13535 13536 13537 13538 13539 |
# File 'lib/oci/core/virtual_network_client.rb', line 13502 def list_virtual_circuit_associated_tunnels(virtual_circuit_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_associated_tunnels.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling list_virtual_circuit_associated_tunnels." if virtual_circuit_id.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}/associatedTunnels'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuit_associated_tunnels') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::VirtualCircuitAssociatedTunnelDetails>' ) end # rubocop:enable Metrics/BlockLength end |
#list_virtual_circuit_bandwidth_shapes(compartment_id, opts = {}) ⇒ Response
13567 13568 13569 13570 13571 13572 13573 13574 13575 13576 13577 13578 13579 13580 13581 13582 13583 13584 13585 13586 13587 13588 13589 13590 13591 13592 13593 13594 13595 13596 13597 13598 13599 13600 13601 13602 13603 13604 |
# File 'lib/oci/core/virtual_network_client.rb', line 13567 def list_virtual_circuit_bandwidth_shapes(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_bandwidth_shapes.' if logger raise "Missing the required parameter 'compartment_id' when calling list_virtual_circuit_bandwidth_shapes." if compartment_id.nil? path = '/virtualCircuitBandwidthShapes' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuit_bandwidth_shapes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::VirtualCircuitBandwidthShape>' ) end # rubocop:enable Metrics/BlockLength end |
#list_virtual_circuit_public_prefixes(virtual_circuit_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_virtual_circuit_public_prefixes API.
Lists the public IP prefixes and their details for the specified public virtual circuit.
13628 13629 13630 13631 13632 13633 13634 13635 13636 13637 13638 13639 13640 13641 13642 13643 13644 13645 13646 13647 13648 13649 13650 13651 13652 13653 13654 13655 13656 13657 13658 13659 13660 13661 13662 13663 13664 13665 13666 13667 13668 |
# File 'lib/oci/core/virtual_network_client.rb', line 13628 def list_virtual_circuit_public_prefixes(virtual_circuit_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuit_public_prefixes.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling list_virtual_circuit_public_prefixes." if virtual_circuit_id.nil? if opts[:verification_state] && !OCI::Core::Models::VirtualCircuitPublicPrefix::VERIFICATION_STATE_ENUM.include?(opts[:verification_state]) raise 'Invalid value for "verification_state", must be one of the values in OCI::Core::Models::VirtualCircuitPublicPrefix::VERIFICATION_STATE_ENUM.' end raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}/publicPrefixes'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:verificationState] = opts[:verification_state] if opts[:verification_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuit_public_prefixes') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::VirtualCircuitPublicPrefix>' ) end # rubocop:enable Metrics/BlockLength end |
#list_virtual_circuits(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_virtual_circuits API.
Lists the virtual circuits in the specified compartment.
13715 13716 13717 13718 13719 13720 13721 13722 13723 13724 13725 13726 13727 13728 13729 13730 13731 13732 13733 13734 13735 13736 13737 13738 13739 13740 13741 13742 13743 13744 13745 13746 13747 13748 13749 13750 13751 13752 13753 13754 13755 13756 13757 13758 13759 13760 13761 13762 13763 13764 13765 13766 13767 13768 |
# File 'lib/oci/core/virtual_network_client.rb', line 13715 def list_virtual_circuits(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_virtual_circuits.' if logger raise "Missing the required parameter 'compartment_id' when calling list_virtual_circuits." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::VirtualCircuit::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::VirtualCircuit::LIFECYCLE_STATE_ENUM.' end path = '/virtualCircuits' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_virtual_circuits') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::VirtualCircuit>' ) end # rubocop:enable Metrics/BlockLength end |
#list_vlans(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_vlans API.
Lists the VLANs in the specified VCN and the specified compartment.
13819 13820 13821 13822 13823 13824 13825 13826 13827 13828 13829 13830 13831 13832 13833 13834 13835 13836 13837 13838 13839 13840 13841 13842 13843 13844 13845 13846 13847 13848 13849 13850 13851 13852 13853 13854 13855 13856 13857 13858 13859 13860 13861 13862 13863 13864 13865 13866 13867 13868 13869 13870 13871 13872 13873 13874 |
# File 'lib/oci/core/virtual_network_client.rb', line 13819 def list_vlans(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_vlans.' if logger raise "Missing the required parameter 'compartment_id' when calling list_vlans." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::Vlan::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Vlan::LIFECYCLE_STATE_ENUM.' end path = '/vlans' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_vlans') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Vlan>' ) end # rubocop:enable Metrics/BlockLength end |
#list_vtaps(compartment_id, opts = {}) ⇒ Response
Click here to see an example of how to use list_vtaps API.
Lists the virtual test access points (VTAPs) in the specified compartment.
13933 13934 13935 13936 13937 13938 13939 13940 13941 13942 13943 13944 13945 13946 13947 13948 13949 13950 13951 13952 13953 13954 13955 13956 13957 13958 13959 13960 13961 13962 13963 13964 13965 13966 13967 13968 13969 13970 13971 13972 13973 13974 13975 13976 13977 13978 13979 13980 13981 13982 13983 13984 13985 13986 13987 13988 13989 13990 13991 13992 |
# File 'lib/oci/core/virtual_network_client.rb', line 13933 def list_vtaps(compartment_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#list_vtaps.' if logger raise "Missing the required parameter 'compartment_id' when calling list_vtaps." if compartment_id.nil? if opts[:sort_by] && !%w[TIMECREATED DISPLAYNAME].include?(opts[:sort_by]) raise 'Invalid value for "sort_by", must be one of TIMECREATED, DISPLAYNAME.' end if opts[:sort_order] && !%w[ASC DESC].include?(opts[:sort_order]) raise 'Invalid value for "sort_order", must be one of ASC, DESC.' end if opts[:lifecycle_state] && !OCI::Core::Models::Vtap::LIFECYCLE_STATE_ENUM.include?(opts[:lifecycle_state]) raise 'Invalid value for "lifecycle_state", must be one of the values in OCI::Core::Models::Vtap::LIFECYCLE_STATE_ENUM.' end path = '/vtaps' operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} query_params[:compartmentId] = compartment_id query_params[:vcnId] = opts[:vcn_id] if opts[:vcn_id] query_params[:source] = opts[:source] if opts[:source] query_params[:targetId] = opts[:target_id] if opts[:target_id] query_params[:targetIp] = opts[:target_ip] if opts[:target_ip] query_params[:isVtapEnabled] = opts[:is_vtap_enabled] if !opts[:is_vtap_enabled].nil? query_params[:limit] = opts[:limit] if opts[:limit] query_params[:page] = opts[:page] if opts[:page] query_params[:sortBy] = opts[:sort_by] if opts[:sort_by] query_params[:sortOrder] = opts[:sort_order] if opts[:sort_order] query_params[:displayName] = opts[:display_name] if opts[:display_name] query_params[:lifecycleState] = opts[:lifecycle_state] if opts[:lifecycle_state] # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#list_vtaps') do @api_client.call_api( :GET, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::Vtap>' ) end # rubocop:enable Metrics/BlockLength end |
#logger ⇒ Logger
Returns The logger for this client. May be nil.
100 101 102 |
# File 'lib/oci/core/virtual_network_client.rb', line 100 def logger @api_client.config.logger end |
#modify_vcn_cidr(vcn_id, modify_vcn_cidr_details, opts = {}) ⇒ Response
Click here to see an example of how to use modify_vcn_cidr API.
Updates the specified CIDR block of a VCN. The new CIDR IP range must meet the following criteria:
-
Must be valid.
-
Must not overlap with another CIDR block in the VCN, a CIDR block of a peered VCN, or the on-premises network CIDR block.
-
Must not exceed the limit of CIDR blocks allowed per VCN.
-
Must include IP addresses from the original CIDR block that are used in the VCN's existing route rules.
-
No IP address in an existing subnet should be outside of the new CIDR block range.
Note: Modifying a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can vary depending on the size of your network. Updating a small network could take about a minute, and updating a large network could take up to an hour. You can use the GetWorkRequest
operation to check the status of the update.
14032 14033 14034 14035 14036 14037 14038 14039 14040 14041 14042 14043 14044 14045 14046 14047 14048 14049 14050 14051 14052 14053 14054 14055 14056 14057 14058 14059 14060 14061 14062 14063 14064 14065 14066 14067 14068 14069 14070 14071 |
# File 'lib/oci/core/virtual_network_client.rb', line 14032 def modify_vcn_cidr(vcn_id, modify_vcn_cidr_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#modify_vcn_cidr.' if logger raise "Missing the required parameter 'vcn_id' when calling modify_vcn_cidr." if vcn_id.nil? raise "Missing the required parameter 'modify_vcn_cidr_details' when calling modify_vcn_cidr." if modify_vcn_cidr_details.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}/actions/modifyCidr'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(modify_vcn_cidr_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#modify_vcn_cidr') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#remove_drg_route_distribution_statements(drg_route_distribution_id, remove_drg_route_distribution_statements_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_drg_route_distribution_statements API.
Removes one or more route distribution statements from the specified route distribution's map.
14092 14093 14094 14095 14096 14097 14098 14099 14100 14101 14102 14103 14104 14105 14106 14107 14108 14109 14110 14111 14112 14113 14114 14115 14116 14117 14118 14119 14120 14121 14122 14123 14124 14125 14126 14127 |
# File 'lib/oci/core/virtual_network_client.rb', line 14092 def remove_drg_route_distribution_statements(drg_route_distribution_id, remove_drg_route_distribution_statements_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_drg_route_distribution_statements.' if logger raise "Missing the required parameter 'drg_route_distribution_id' when calling remove_drg_route_distribution_statements." if drg_route_distribution_id.nil? raise "Missing the required parameter 'remove_drg_route_distribution_statements_details' when calling remove_drg_route_distribution_statements." if remove_drg_route_distribution_statements_details.nil? raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id) path = '/drgRouteDistributions/{drgRouteDistributionId}/actions/removeDrgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(remove_drg_route_distribution_statements_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_drg_route_distribution_statements') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#remove_drg_route_rules(drg_route_table_id, remove_drg_route_rules_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_drg_route_rules API.
Removes one or more route rules from the specified DRG route table.
14149 14150 14151 14152 14153 14154 14155 14156 14157 14158 14159 14160 14161 14162 14163 14164 14165 14166 14167 14168 14169 14170 14171 14172 14173 14174 14175 14176 14177 14178 14179 14180 14181 14182 14183 14184 |
# File 'lib/oci/core/virtual_network_client.rb', line 14149 def remove_drg_route_rules(drg_route_table_id, remove_drg_route_rules_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_drg_route_rules.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling remove_drg_route_rules." if drg_route_table_id.nil? raise "Missing the required parameter 'remove_drg_route_rules_details' when calling remove_drg_route_rules." if remove_drg_route_rules_details.nil? raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}/actions/removeDrgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(remove_drg_route_rules_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_drg_route_rules') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#remove_export_drg_route_distribution(drg_attachment_id, opts = {}) ⇒ Response
Click here to see an example of how to use remove_export_drg_route_distribution API.
Removes the export route distribution from the DRG attachment so no routes are advertised to it.
14210 14211 14212 14213 14214 14215 14216 14217 14218 14219 14220 14221 14222 14223 14224 14225 14226 14227 14228 14229 14230 14231 14232 14233 14234 14235 14236 14237 14238 14239 14240 14241 14242 14243 14244 14245 14246 14247 |
# File 'lib/oci/core/virtual_network_client.rb', line 14210 def remove_export_drg_route_distribution(, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_export_drg_route_distribution.' if logger raise "Missing the required parameter 'drg_attachment_id' when calling remove_export_drg_route_distribution." if .nil? raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/drgAttachments/{drgAttachmentId}/actions/removeExportDrgRouteDistribution'.sub('{drgAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_export_drg_route_distribution') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#remove_import_drg_route_distribution(drg_route_table_id, opts = {}) ⇒ Response
Click here to see an example of how to use remove_import_drg_route_distribution API.
Removes the import route distribution from the DRG route table so no routes are imported into it.
14273 14274 14275 14276 14277 14278 14279 14280 14281 14282 14283 14284 14285 14286 14287 14288 14289 14290 14291 14292 14293 14294 14295 14296 14297 14298 14299 14300 14301 14302 14303 14304 14305 14306 14307 14308 14309 14310 |
# File 'lib/oci/core/virtual_network_client.rb', line 14273 def remove_import_drg_route_distribution(drg_route_table_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_import_drg_route_distribution.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling remove_import_drg_route_distribution." if drg_route_table_id.nil? raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}/actions/removeImportDrgRouteDistribution'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_import_drg_route_distribution') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRouteTable' ) end # rubocop:enable Metrics/BlockLength end |
#remove_ipv6_subnet_cidr(subnet_id, remove_subnet_ipv6_cidr_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_ipv6_subnet_cidr API.
Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain.
14342 14343 14344 14345 14346 14347 14348 14349 14350 14351 14352 14353 14354 14355 14356 14357 14358 14359 14360 14361 14362 14363 14364 14365 14366 14367 14368 14369 14370 14371 14372 14373 14374 14375 14376 14377 14378 14379 14380 14381 |
# File 'lib/oci/core/virtual_network_client.rb', line 14342 def remove_ipv6_subnet_cidr(subnet_id, remove_subnet_ipv6_cidr_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_ipv6_subnet_cidr.' if logger raise "Missing the required parameter 'subnet_id' when calling remove_ipv6_subnet_cidr." if subnet_id.nil? raise "Missing the required parameter 'remove_subnet_ipv6_cidr_details' when calling remove_ipv6_subnet_cidr." if remove_subnet_ipv6_cidr_details.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/subnets/{subnetId}/actions/removeIpv6Cidr'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(remove_subnet_ipv6_cidr_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_ipv6_subnet_cidr') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#remove_ipv6_vcn_cidr(vcn_id, opts = {}) ⇒ Response
Click here to see an example of how to use remove_ipv6_vcn_cidr API.
Removing an existing IPv6 prefix from a VCN.
14413 14414 14415 14416 14417 14418 14419 14420 14421 14422 14423 14424 14425 14426 14427 14428 14429 14430 14431 14432 14433 14434 14435 14436 14437 14438 14439 14440 14441 14442 14443 14444 14445 14446 14447 14448 14449 14450 14451 |
# File 'lib/oci/core/virtual_network_client.rb', line 14413 def remove_ipv6_vcn_cidr(vcn_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_ipv6_vcn_cidr.' if logger raise "Missing the required parameter 'vcn_id' when calling remove_ipv6_vcn_cidr." if vcn_id.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}/actions/removeIpv6Cidr'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(opts[:remove_vcn_ipv6_cidr_details]) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_ipv6_vcn_cidr') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#remove_network_security_group_security_rules(network_security_group_id, remove_network_security_group_security_rules_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_network_security_group_security_rules API.
Removes one or more security rules from the specified network security group.
14473 14474 14475 14476 14477 14478 14479 14480 14481 14482 14483 14484 14485 14486 14487 14488 14489 14490 14491 14492 14493 14494 14495 14496 14497 14498 14499 14500 14501 14502 14503 14504 14505 14506 14507 14508 |
# File 'lib/oci/core/virtual_network_client.rb', line 14473 def remove_network_security_group_security_rules(network_security_group_id, remove_network_security_group_security_rules_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_network_security_group_security_rules.' if logger raise "Missing the required parameter 'network_security_group_id' when calling remove_network_security_group_security_rules." if network_security_group_id.nil? raise "Missing the required parameter 'remove_network_security_group_security_rules_details' when calling remove_network_security_group_security_rules." if remove_network_security_group_security_rules_details.nil? raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/removeSecurityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(remove_network_security_group_security_rules_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_network_security_group_security_rules') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#remove_public_ip_pool_capacity(public_ip_pool_id, remove_public_ip_pool_capacity_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_public_ip_pool_capacity API.
Removes a CIDR block from the referenced public IP pool.
14537 14538 14539 14540 14541 14542 14543 14544 14545 14546 14547 14548 14549 14550 14551 14552 14553 14554 14555 14556 14557 14558 14559 14560 14561 14562 14563 14564 14565 14566 14567 14568 14569 14570 14571 14572 14573 14574 14575 14576 |
# File 'lib/oci/core/virtual_network_client.rb', line 14537 def remove_public_ip_pool_capacity(public_ip_pool_id, remove_public_ip_pool_capacity_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_public_ip_pool_capacity.' if logger raise "Missing the required parameter 'public_ip_pool_id' when calling remove_public_ip_pool_capacity." if public_ip_pool_id.nil? raise "Missing the required parameter 'remove_public_ip_pool_capacity_details' when calling remove_public_ip_pool_capacity." if remove_public_ip_pool_capacity_details.nil? raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id) path = '/publicIpPools/{publicIpPoolId}/actions/removeCapacity'.sub('{publicIpPoolId}', public_ip_pool_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(remove_public_ip_pool_capacity_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_public_ip_pool_capacity') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIpPool' ) end # rubocop:enable Metrics/BlockLength end |
#remove_vcn_cidr(vcn_id, remove_vcn_cidr_details, opts = {}) ⇒ Response
Click here to see an example of how to use remove_vcn_cidr API.
Removes a specified CIDR block from a VCN.
Notes: - You cannot remove a CIDR block if an IP address in its range is in use. - Removing a CIDR block places your VCN in an updating state until the changes are complete. You cannot create or update the VCN's subnets, VLANs, LPGs, or route tables during this operation. The time to completion can take a few minutes. You can use the GetWorkRequest
operation to check the status of the update.
14612 14613 14614 14615 14616 14617 14618 14619 14620 14621 14622 14623 14624 14625 14626 14627 14628 14629 14630 14631 14632 14633 14634 14635 14636 14637 14638 14639 14640 14641 14642 14643 14644 14645 14646 14647 14648 14649 14650 14651 |
# File 'lib/oci/core/virtual_network_client.rb', line 14612 def remove_vcn_cidr(vcn_id, remove_vcn_cidr_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#remove_vcn_cidr.' if logger raise "Missing the required parameter 'vcn_id' when calling remove_vcn_cidr." if vcn_id.nil? raise "Missing the required parameter 'remove_vcn_cidr_details' when calling remove_vcn_cidr." if remove_vcn_cidr_details.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}/actions/removeCidr'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(remove_vcn_cidr_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#remove_vcn_cidr') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#update_byoip_range(byoip_range_id, update_byoip_range_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_byoip_range API.
Updates the tags or display name associated to the specified BYOIP CIDR block.
14677 14678 14679 14680 14681 14682 14683 14684 14685 14686 14687 14688 14689 14690 14691 14692 14693 14694 14695 14696 14697 14698 14699 14700 14701 14702 14703 14704 14705 14706 14707 14708 14709 14710 14711 14712 14713 14714 14715 |
# File 'lib/oci/core/virtual_network_client.rb', line 14677 def update_byoip_range(byoip_range_id, update_byoip_range_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_byoip_range.' if logger raise "Missing the required parameter 'byoip_range_id' when calling update_byoip_range." if byoip_range_id.nil? raise "Missing the required parameter 'update_byoip_range_details' when calling update_byoip_range." if update_byoip_range_details.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_byoip_range_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_byoip_range') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ByoipRange' ) end # rubocop:enable Metrics/BlockLength end |
#update_capture_filter(capture_filter_id, update_capture_filter_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_capture_filter API.
Updates the specified VTAP capture filter's display name or tags.
14741 14742 14743 14744 14745 14746 14747 14748 14749 14750 14751 14752 14753 14754 14755 14756 14757 14758 14759 14760 14761 14762 14763 14764 14765 14766 14767 14768 14769 14770 14771 14772 14773 14774 14775 14776 14777 14778 14779 |
# File 'lib/oci/core/virtual_network_client.rb', line 14741 def update_capture_filter(capture_filter_id, update_capture_filter_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_capture_filter.' if logger raise "Missing the required parameter 'capture_filter_id' when calling update_capture_filter." if capture_filter_id.nil? raise "Missing the required parameter 'update_capture_filter_details' when calling update_capture_filter." if update_capture_filter_details.nil? raise "Parameter value for 'capture_filter_id' must not be blank" if OCI::Internal::Util.blank_string?(capture_filter_id) path = '/captureFilters/{captureFilterId}'.sub('{captureFilterId}', capture_filter_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_capture_filter_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_capture_filter') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CaptureFilter' ) end # rubocop:enable Metrics/BlockLength end |
#update_cpe(cpe_id, update_cpe_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_cpe API.
Updates the specified CPE's display name or tags. Avoid entering confidential information.
14803 14804 14805 14806 14807 14808 14809 14810 14811 14812 14813 14814 14815 14816 14817 14818 14819 14820 14821 14822 14823 14824 14825 14826 14827 14828 14829 14830 14831 14832 14833 14834 14835 14836 14837 14838 14839 14840 |
# File 'lib/oci/core/virtual_network_client.rb', line 14803 def update_cpe(cpe_id, update_cpe_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_cpe.' if logger raise "Missing the required parameter 'cpe_id' when calling update_cpe." if cpe_id.nil? raise "Missing the required parameter 'update_cpe_details' when calling update_cpe." if update_cpe_details.nil? raise "Parameter value for 'cpe_id' must not be blank" if OCI::Internal::Util.blank_string?(cpe_id) path = '/cpes/{cpeId}'.sub('{cpeId}', cpe_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_cpe_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_cpe') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Cpe' ) end # rubocop:enable Metrics/BlockLength end |
#update_cross_connect(cross_connect_id, update_cross_connect_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_cross_connect API.
Updates the specified cross-connect.
14862 14863 14864 14865 14866 14867 14868 14869 14870 14871 14872 14873 14874 14875 14876 14877 14878 14879 14880 14881 14882 14883 14884 14885 14886 14887 14888 14889 14890 14891 14892 14893 14894 14895 14896 14897 14898 14899 |
# File 'lib/oci/core/virtual_network_client.rb', line 14862 def update_cross_connect(cross_connect_id, update_cross_connect_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_cross_connect.' if logger raise "Missing the required parameter 'cross_connect_id' when calling update_cross_connect." if cross_connect_id.nil? raise "Missing the required parameter 'update_cross_connect_details' when calling update_cross_connect." if update_cross_connect_details.nil? raise "Parameter value for 'cross_connect_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_id) path = '/crossConnects/{crossConnectId}'.sub('{crossConnectId}', cross_connect_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_cross_connect_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_cross_connect') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnect' ) end # rubocop:enable Metrics/BlockLength end |
#update_cross_connect_group(cross_connect_group_id, update_cross_connect_group_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_cross_connect_group API.
Updates the specified cross-connect group's display name. Avoid entering confidential information.
14923 14924 14925 14926 14927 14928 14929 14930 14931 14932 14933 14934 14935 14936 14937 14938 14939 14940 14941 14942 14943 14944 14945 14946 14947 14948 14949 14950 14951 14952 14953 14954 14955 14956 14957 14958 14959 14960 |
# File 'lib/oci/core/virtual_network_client.rb', line 14923 def update_cross_connect_group(cross_connect_group_id, update_cross_connect_group_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_cross_connect_group.' if logger raise "Missing the required parameter 'cross_connect_group_id' when calling update_cross_connect_group." if cross_connect_group_id.nil? raise "Missing the required parameter 'update_cross_connect_group_details' when calling update_cross_connect_group." if update_cross_connect_group_details.nil? raise "Parameter value for 'cross_connect_group_id' must not be blank" if OCI::Internal::Util.blank_string?(cross_connect_group_id) path = '/crossConnectGroups/{crossConnectGroupId}'.sub('{crossConnectGroupId}', cross_connect_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_cross_connect_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_cross_connect_group') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::CrossConnectGroup' ) end # rubocop:enable Metrics/BlockLength end |
#update_dhcp_options(dhcp_id, update_dhcp_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_dhcp_options API.
Updates the specified set of DHCP options. You can update the display name or the options themselves. Avoid entering confidential information.
Note that the options
object you provide replaces the entire existing set of options.
14986 14987 14988 14989 14990 14991 14992 14993 14994 14995 14996 14997 14998 14999 15000 15001 15002 15003 15004 15005 15006 15007 15008 15009 15010 15011 15012 15013 15014 15015 15016 15017 15018 15019 15020 15021 15022 15023 |
# File 'lib/oci/core/virtual_network_client.rb', line 14986 def (dhcp_id, update_dhcp_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_dhcp_options.' if logger raise "Missing the required parameter 'dhcp_id' when calling update_dhcp_options." if dhcp_id.nil? raise "Missing the required parameter 'update_dhcp_details' when calling update_dhcp_options." if update_dhcp_details.nil? raise "Parameter value for 'dhcp_id' must not be blank" if OCI::Internal::Util.blank_string?(dhcp_id) path = '/dhcps/{dhcpId}'.sub('{dhcpId}', dhcp_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_dhcp_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_dhcp_options') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DhcpOptions' ) end # rubocop:enable Metrics/BlockLength end |
#update_drg(drg_id, update_drg_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_drg API.
Updates the specified DRG's display name or tags. Avoid entering confidential information.
15046 15047 15048 15049 15050 15051 15052 15053 15054 15055 15056 15057 15058 15059 15060 15061 15062 15063 15064 15065 15066 15067 15068 15069 15070 15071 15072 15073 15074 15075 15076 15077 15078 15079 15080 15081 15082 15083 |
# File 'lib/oci/core/virtual_network_client.rb', line 15046 def update_drg(drg_id, update_drg_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_drg.' if logger raise "Missing the required parameter 'drg_id' when calling update_drg." if drg_id.nil? raise "Missing the required parameter 'update_drg_details' when calling update_drg." if update_drg_details.nil? raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_drg_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Drg' ) end # rubocop:enable Metrics/BlockLength end |
#update_drg_attachment(drg_attachment_id, update_drg_attachment_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_drg_attachment API.
Updates the display name and routing information for the specified DrgAttachment
. Avoid entering confidential information.
15107 15108 15109 15110 15111 15112 15113 15114 15115 15116 15117 15118 15119 15120 15121 15122 15123 15124 15125 15126 15127 15128 15129 15130 15131 15132 15133 15134 15135 15136 15137 15138 15139 15140 15141 15142 15143 15144 |
# File 'lib/oci/core/virtual_network_client.rb', line 15107 def (, , opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_drg_attachment.' if logger raise "Missing the required parameter 'drg_attachment_id' when calling update_drg_attachment." if .nil? raise "Missing the required parameter 'update_drg_attachment_details' when calling update_drg_attachment." if .nil? raise "Parameter value for 'drg_attachment_id' must not be blank" if OCI::Internal::Util.blank_string?() path = '/drgAttachments/{drgAttachmentId}'.sub('{drgAttachmentId}', .to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body() # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_attachment') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgAttachment' ) end # rubocop:enable Metrics/BlockLength end |
#update_drg_route_distribution(drg_route_distribution_id, update_drg_route_distribution_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_drg_route_distribution API.
Updates the specified route distribution
15167 15168 15169 15170 15171 15172 15173 15174 15175 15176 15177 15178 15179 15180 15181 15182 15183 15184 15185 15186 15187 15188 15189 15190 15191 15192 15193 15194 15195 15196 15197 15198 15199 15200 15201 15202 15203 15204 |
# File 'lib/oci/core/virtual_network_client.rb', line 15167 def update_drg_route_distribution(drg_route_distribution_id, update_drg_route_distribution_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_distribution.' if logger raise "Missing the required parameter 'drg_route_distribution_id' when calling update_drg_route_distribution." if drg_route_distribution_id.nil? raise "Missing the required parameter 'update_drg_route_distribution_details' when calling update_drg_route_distribution." if update_drg_route_distribution_details.nil? raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id) path = '/drgRouteDistributions/{drgRouteDistributionId}'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_drg_route_distribution_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_distribution') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRouteDistribution' ) end # rubocop:enable Metrics/BlockLength end |
#update_drg_route_distribution_statements(drg_route_distribution_id, update_drg_route_distribution_statements_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_drg_route_distribution_statements API.
Updates one or more route distribution statements in the specified route distribution.
15225 15226 15227 15228 15229 15230 15231 15232 15233 15234 15235 15236 15237 15238 15239 15240 15241 15242 15243 15244 15245 15246 15247 15248 15249 15250 15251 15252 15253 15254 15255 15256 15257 15258 15259 15260 15261 |
# File 'lib/oci/core/virtual_network_client.rb', line 15225 def update_drg_route_distribution_statements(drg_route_distribution_id, update_drg_route_distribution_statements_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_distribution_statements.' if logger raise "Missing the required parameter 'drg_route_distribution_id' when calling update_drg_route_distribution_statements." if drg_route_distribution_id.nil? raise "Missing the required parameter 'update_drg_route_distribution_statements_details' when calling update_drg_route_distribution_statements." if update_drg_route_distribution_statements_details.nil? raise "Parameter value for 'drg_route_distribution_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_distribution_id) path = '/drgRouteDistributions/{drgRouteDistributionId}/actions/updateDrgRouteDistributionStatements'.sub('{drgRouteDistributionId}', drg_route_distribution_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_drg_route_distribution_statements_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_distribution_statements') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteDistributionStatement>' ) end # rubocop:enable Metrics/BlockLength end |
#update_drg_route_rules(drg_route_table_id, update_drg_route_rules_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_drg_route_rules API.
Updates one or more route rules in the specified DRG route table.
15283 15284 15285 15286 15287 15288 15289 15290 15291 15292 15293 15294 15295 15296 15297 15298 15299 15300 15301 15302 15303 15304 15305 15306 15307 15308 15309 15310 15311 15312 15313 15314 15315 15316 15317 15318 15319 |
# File 'lib/oci/core/virtual_network_client.rb', line 15283 def update_drg_route_rules(drg_route_table_id, update_drg_route_rules_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_rules.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling update_drg_route_rules." if drg_route_table_id.nil? raise "Missing the required parameter 'update_drg_route_rules_details' when calling update_drg_route_rules." if update_drg_route_rules_details.nil? raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}/actions/updateDrgRouteRules'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_drg_route_rules_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_rules') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'Array<OCI::Core::Models::DrgRouteRule>' ) end # rubocop:enable Metrics/BlockLength end |
#update_drg_route_table(drg_route_table_id, update_drg_route_table_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_drg_route_table API.
Updates the specified DRG route table.
15343 15344 15345 15346 15347 15348 15349 15350 15351 15352 15353 15354 15355 15356 15357 15358 15359 15360 15361 15362 15363 15364 15365 15366 15367 15368 15369 15370 15371 15372 15373 15374 15375 15376 15377 15378 15379 15380 |
# File 'lib/oci/core/virtual_network_client.rb', line 15343 def update_drg_route_table(drg_route_table_id, update_drg_route_table_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_drg_route_table.' if logger raise "Missing the required parameter 'drg_route_table_id' when calling update_drg_route_table." if drg_route_table_id.nil? raise "Missing the required parameter 'update_drg_route_table_details' when calling update_drg_route_table." if update_drg_route_table_details.nil? raise "Parameter value for 'drg_route_table_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_route_table_id) path = '/drgRouteTables/{drgRouteTableId}'.sub('{drgRouteTableId}', drg_route_table_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_drg_route_table_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_drg_route_table') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::DrgRouteTable' ) end # rubocop:enable Metrics/BlockLength end |
#update_internet_gateway(ig_id, update_internet_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_internet_gateway API.
Updates the specified internet gateway. You can disable/enable it, or change its display name or tags. Avoid entering confidential information.
If the gateway is disabled, that means no traffic will flow to/from the internet even if there's a route rule that enables that traffic.
15407 15408 15409 15410 15411 15412 15413 15414 15415 15416 15417 15418 15419 15420 15421 15422 15423 15424 15425 15426 15427 15428 15429 15430 15431 15432 15433 15434 15435 15436 15437 15438 15439 15440 15441 15442 15443 15444 |
# File 'lib/oci/core/virtual_network_client.rb', line 15407 def update_internet_gateway(ig_id, update_internet_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_internet_gateway.' if logger raise "Missing the required parameter 'ig_id' when calling update_internet_gateway." if ig_id.nil? raise "Missing the required parameter 'update_internet_gateway_details' when calling update_internet_gateway." if update_internet_gateway_details.nil? raise "Parameter value for 'ig_id' must not be blank" if OCI::Internal::Util.blank_string?(ig_id) path = '/internetGateways/{igId}'.sub('{igId}', ig_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_internet_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_internet_gateway') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::InternetGateway' ) end # rubocop:enable Metrics/BlockLength end |
#update_ip_sec_connection(ipsc_id, update_ip_sec_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_ip_sec_connection API.
Updates the specified IPSec connection.
To update an individual IPSec tunnel's attributes, use update_ip_sec_connection_tunnel.
15470 15471 15472 15473 15474 15475 15476 15477 15478 15479 15480 15481 15482 15483 15484 15485 15486 15487 15488 15489 15490 15491 15492 15493 15494 15495 15496 15497 15498 15499 15500 15501 15502 15503 15504 15505 15506 15507 |
# File 'lib/oci/core/virtual_network_client.rb', line 15470 def update_ip_sec_connection(ipsc_id, update_ip_sec_connection_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_ip_sec_connection.' if logger raise "Missing the required parameter 'ipsc_id' when calling update_ip_sec_connection." if ipsc_id.nil? raise "Missing the required parameter 'update_ip_sec_connection_details' when calling update_ip_sec_connection." if update_ip_sec_connection_details.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) path = '/ipsecConnections/{ipscId}'.sub('{ipscId}', ipsc_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_ip_sec_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ip_sec_connection') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnection' ) end # rubocop:enable Metrics/BlockLength end |
#update_ip_sec_connection_tunnel(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_ip_sec_connection_tunnel API.
Updates the specified tunnel. This operation lets you change tunnel attributes such as the routing type (BGP dynamic routing or static routing). Here are some important notes:
-
If you change the tunnel's routing type or BGP session configuration, the tunnel will go down while it's reprovisioned.
-
If you want to switch the tunnel's
routing
fromSTATIC
toBGP
, make sure the tunnel's BGP session configuration attributes have been set (bgp_session_info). -
If you want to switch the tunnel's
routing
fromBGP
toSTATIC
, make sure the IPSecConnection already has at least one valid CIDR static route.
15545 15546 15547 15548 15549 15550 15551 15552 15553 15554 15555 15556 15557 15558 15559 15560 15561 15562 15563 15564 15565 15566 15567 15568 15569 15570 15571 15572 15573 15574 15575 15576 15577 15578 15579 15580 15581 15582 15583 15584 15585 |
# File 'lib/oci/core/virtual_network_client.rb', line 15545 def update_ip_sec_connection_tunnel(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_ip_sec_connection_tunnel.' if logger raise "Missing the required parameter 'ipsc_id' when calling update_ip_sec_connection_tunnel." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling update_ip_sec_connection_tunnel." if tunnel_id.nil? raise "Missing the required parameter 'update_ip_sec_connection_tunnel_details' when calling update_ip_sec_connection_tunnel." if update_ip_sec_connection_tunnel_details.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_ip_sec_connection_tunnel_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ip_sec_connection_tunnel') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnectionTunnel' ) end # rubocop:enable Metrics/BlockLength end |
#update_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_shared_secret_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_ip_sec_connection_tunnel_shared_secret API.
Updates the shared secret (pre-shared key) for the specified tunnel.
Important: If you change the shared secret, the tunnel will go down while it's reprovisioned.
15611 15612 15613 15614 15615 15616 15617 15618 15619 15620 15621 15622 15623 15624 15625 15626 15627 15628 15629 15630 15631 15632 15633 15634 15635 15636 15637 15638 15639 15640 15641 15642 15643 15644 15645 15646 15647 15648 15649 15650 |
# File 'lib/oci/core/virtual_network_client.rb', line 15611 def update_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_shared_secret_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_ip_sec_connection_tunnel_shared_secret.' if logger raise "Missing the required parameter 'ipsc_id' when calling update_ip_sec_connection_tunnel_shared_secret." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling update_ip_sec_connection_tunnel_shared_secret." if tunnel_id.nil? raise "Missing the required parameter 'update_ip_sec_connection_tunnel_shared_secret_details' when calling update_ip_sec_connection_tunnel_shared_secret." if update_ip_sec_connection_tunnel_shared_secret_details.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/sharedSecret'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_ip_sec_connection_tunnel_shared_secret_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ip_sec_connection_tunnel_shared_secret') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::IPSecConnectionTunnelSharedSecret' ) end # rubocop:enable Metrics/BlockLength end |
#update_ipv6(ipv6_id, update_ipv6_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_ipv6 API.
Updates the specified IPv6. You must specify the object's OCID. Use this operation if you want to:
-
Move an IPv6 to a different VNIC in the same subnet.
-
Enable/disable internet access for an IPv6.
-
Change the display name for an IPv6.
-
Update resource tags for an IPv6.
15682 15683 15684 15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 15699 15700 15701 15702 15703 15704 15705 15706 15707 15708 15709 15710 15711 15712 15713 15714 15715 15716 15717 15718 15719 15720 |
# File 'lib/oci/core/virtual_network_client.rb', line 15682 def update_ipv6(ipv6_id, update_ipv6_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_ipv6.' if logger raise "Missing the required parameter 'ipv6_id' when calling update_ipv6." if ipv6_id.nil? raise "Missing the required parameter 'update_ipv6_details' when calling update_ipv6." if update_ipv6_details.nil? raise "Parameter value for 'ipv6_id' must not be blank" if OCI::Internal::Util.blank_string?(ipv6_id) path = '/ipv6/{ipv6Id}'.sub('{ipv6Id}', ipv6_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_ipv6_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_ipv6') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Ipv6' ) end # rubocop:enable Metrics/BlockLength end |
#update_local_peering_gateway(local_peering_gateway_id, update_local_peering_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_local_peering_gateway API.
Updates the specified local peering gateway (LPG).
15743 15744 15745 15746 15747 15748 15749 15750 15751 15752 15753 15754 15755 15756 15757 15758 15759 15760 15761 15762 15763 15764 15765 15766 15767 15768 15769 15770 15771 15772 15773 15774 15775 15776 15777 15778 15779 15780 |
# File 'lib/oci/core/virtual_network_client.rb', line 15743 def update_local_peering_gateway(local_peering_gateway_id, update_local_peering_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_local_peering_gateway.' if logger raise "Missing the required parameter 'local_peering_gateway_id' when calling update_local_peering_gateway." if local_peering_gateway_id.nil? raise "Missing the required parameter 'update_local_peering_gateway_details' when calling update_local_peering_gateway." if update_local_peering_gateway_details.nil? raise "Parameter value for 'local_peering_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(local_peering_gateway_id) path = '/localPeeringGateways/{localPeeringGatewayId}'.sub('{localPeeringGatewayId}', local_peering_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_local_peering_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_local_peering_gateway') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::LocalPeeringGateway' ) end # rubocop:enable Metrics/BlockLength end |
#update_nat_gateway(nat_gateway_id, update_nat_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_nat_gateway API.
Updates the specified NAT gateway.
15803 15804 15805 15806 15807 15808 15809 15810 15811 15812 15813 15814 15815 15816 15817 15818 15819 15820 15821 15822 15823 15824 15825 15826 15827 15828 15829 15830 15831 15832 15833 15834 15835 15836 15837 15838 15839 15840 |
# File 'lib/oci/core/virtual_network_client.rb', line 15803 def update_nat_gateway(nat_gateway_id, update_nat_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_nat_gateway.' if logger raise "Missing the required parameter 'nat_gateway_id' when calling update_nat_gateway." if nat_gateway_id.nil? raise "Missing the required parameter 'update_nat_gateway_details' when calling update_nat_gateway." if update_nat_gateway_details.nil? raise "Parameter value for 'nat_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(nat_gateway_id) path = '/natGateways/{natGatewayId}'.sub('{natGatewayId}', nat_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_nat_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_nat_gateway') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::NatGateway' ) end # rubocop:enable Metrics/BlockLength end |
#update_network_security_group(network_security_group_id, update_network_security_group_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_network_security_group API.
Updates the specified network security group.
To add or remove an existing VNIC from the group, use update_vnic.
To add a VNIC to the group when you create the VNIC, specify the NSG's OCID during creation. For example, see the nsgIds
attribute in create_vnic_details.
To add or remove security rules from the group, use add_network_security_group_security_rules or remove_network_security_group_security_rules.
To edit the contents of existing security rules in the group, use update_network_security_group_security_rules.
15877 15878 15879 15880 15881 15882 15883 15884 15885 15886 15887 15888 15889 15890 15891 15892 15893 15894 15895 15896 15897 15898 15899 15900 15901 15902 15903 15904 15905 15906 15907 15908 15909 15910 15911 15912 15913 15914 |
# File 'lib/oci/core/virtual_network_client.rb', line 15877 def update_network_security_group(network_security_group_id, update_network_security_group_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_network_security_group.' if logger raise "Missing the required parameter 'network_security_group_id' when calling update_network_security_group." if network_security_group_id.nil? raise "Missing the required parameter 'update_network_security_group_details' when calling update_network_security_group." if update_network_security_group_details.nil? raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_network_security_group_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_network_security_group') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::NetworkSecurityGroup' ) end # rubocop:enable Metrics/BlockLength end |
#update_network_security_group_security_rules(network_security_group_id, update_network_security_group_security_rules_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_network_security_group_security_rules API.
Updates one or more security rules in the specified network security group.
15936 15937 15938 15939 15940 15941 15942 15943 15944 15945 15946 15947 15948 15949 15950 15951 15952 15953 15954 15955 15956 15957 15958 15959 15960 15961 15962 15963 15964 15965 15966 15967 15968 15969 15970 15971 15972 |
# File 'lib/oci/core/virtual_network_client.rb', line 15936 def update_network_security_group_security_rules(network_security_group_id, update_network_security_group_security_rules_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_network_security_group_security_rules.' if logger raise "Missing the required parameter 'network_security_group_id' when calling update_network_security_group_security_rules." if network_security_group_id.nil? raise "Missing the required parameter 'update_network_security_group_security_rules_details' when calling update_network_security_group_security_rules." if update_network_security_group_security_rules_details.nil? raise "Parameter value for 'network_security_group_id' must not be blank" if OCI::Internal::Util.blank_string?(network_security_group_id) path = '/networkSecurityGroups/{networkSecurityGroupId}/actions/updateSecurityRules'.sub('{networkSecurityGroupId}', network_security_group_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_network_security_group_security_rules_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_network_security_group_security_rules') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::UpdatedNetworkSecurityGroupSecurityRules' ) end # rubocop:enable Metrics/BlockLength end |
#update_private_ip(private_ip_id, update_private_ip_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_private_ip API.
Updates the specified private IP. You must specify the object's OCID. Use this operation if you want to:
-
Move a secondary private IP to a different VNIC in the same subnet.
-
Change the display name for a secondary private IP.
-
Change the hostname for a secondary private IP.
This operation cannot be used with primary private IPs. To update the hostname for the primary IP on a VNIC, use update_vnic.
16005 16006 16007 16008 16009 16010 16011 16012 16013 16014 16015 16016 16017 16018 16019 16020 16021 16022 16023 16024 16025 16026 16027 16028 16029 16030 16031 16032 16033 16034 16035 16036 16037 16038 16039 16040 16041 16042 |
# File 'lib/oci/core/virtual_network_client.rb', line 16005 def update_private_ip(private_ip_id, update_private_ip_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_private_ip.' if logger raise "Missing the required parameter 'private_ip_id' when calling update_private_ip." if private_ip_id.nil? raise "Missing the required parameter 'update_private_ip_details' when calling update_private_ip." if update_private_ip_details.nil? raise "Parameter value for 'private_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(private_ip_id) path = '/privateIps/{privateIpId}'.sub('{privateIpId}', private_ip_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_private_ip_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_private_ip') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PrivateIp' ) end # rubocop:enable Metrics/BlockLength end |
#update_public_ip(public_ip_id, update_public_ip_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_public_ip API.
Updates the specified public IP. You must specify the object's OCID. Use this operation if you want to:
-
Assign a reserved public IP in your pool to a private IP.
-
Move a reserved public IP to a different private IP.
-
Unassign a reserved public IP from a private IP (which returns it to your pool of reserved public IPs).
-
Change the display name or tags for a public IP.
Assigning, moving, and unassigning a reserved public IP are asynchronous operations. Poll the public IP's lifecycleState
to determine if the operation succeeded.
Note: When moving a reserved public IP, the target private IP must not already have a public IP with lifecycleState
= ASSIGNING or ASSIGNED. If it does, an error is returned. Also, the initial unassignment from the original private IP always succeeds, but the assignment to the target private IP is asynchronous and could fail silently (for example, if the target private IP is deleted or has a different public IP assigned to it in the interim). If that occurs, the public IP remains unassigned and its lifecycleState
switches to AVAILABLE (it is not reassigned to its original private IP). You must poll the public IP's lifecycleState
to determine if the move succeeded.
Regarding ephemeral public IPs:
-
If you want to assign an ephemeral public IP to a primary private IP, use create_public_ip.
-
You can't move an ephemeral public IP to a different private IP.
-
If you want to unassign an ephemeral public IP from its private IP, use delete_public_ip, which unassigns and deletes the ephemeral public IP.
Note: If a public IP is assigned to a secondary private IP (see PrivateIp), and you move that secondary private IP to another VNIC, the public IP moves with it.
Note: There's a limit to the number of PublicIp} a VNIC or instance can have. If you try to move a reserved public IP to a VNIC or instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see {Public IP Addresses.
16103 16104 16105 16106 16107 16108 16109 16110 16111 16112 16113 16114 16115 16116 16117 16118 16119 16120 16121 16122 16123 16124 16125 16126 16127 16128 16129 16130 16131 16132 16133 16134 16135 16136 16137 16138 16139 16140 |
# File 'lib/oci/core/virtual_network_client.rb', line 16103 def update_public_ip(public_ip_id, update_public_ip_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_public_ip.' if logger raise "Missing the required parameter 'public_ip_id' when calling update_public_ip." if public_ip_id.nil? raise "Missing the required parameter 'update_public_ip_details' when calling update_public_ip." if update_public_ip_details.nil? raise "Parameter value for 'public_ip_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_id) path = '/publicIps/{publicIpId}'.sub('{publicIpId}', public_ip_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_public_ip_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_public_ip') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIp' ) end # rubocop:enable Metrics/BlockLength end |
#update_public_ip_pool(public_ip_pool_id, update_public_ip_pool_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_public_ip_pool API.
Updates the specified public IP pool.
16166 16167 16168 16169 16170 16171 16172 16173 16174 16175 16176 16177 16178 16179 16180 16181 16182 16183 16184 16185 16186 16187 16188 16189 16190 16191 16192 16193 16194 16195 16196 16197 16198 16199 16200 16201 16202 16203 16204 |
# File 'lib/oci/core/virtual_network_client.rb', line 16166 def update_public_ip_pool(public_ip_pool_id, update_public_ip_pool_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_public_ip_pool.' if logger raise "Missing the required parameter 'public_ip_pool_id' when calling update_public_ip_pool." if public_ip_pool_id.nil? raise "Missing the required parameter 'update_public_ip_pool_details' when calling update_public_ip_pool." if update_public_ip_pool_details.nil? raise "Parameter value for 'public_ip_pool_id' must not be blank" if OCI::Internal::Util.blank_string?(public_ip_pool_id) path = '/publicIpPools/{publicIpPoolId}'.sub('{publicIpPoolId}', public_ip_pool_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_public_ip_pool_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_public_ip_pool') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::PublicIpPool' ) end # rubocop:enable Metrics/BlockLength end |
#update_remote_peering_connection(remote_peering_connection_id, update_remote_peering_connection_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_remote_peering_connection API.
Updates the specified remote peering connection (RPC).
16227 16228 16229 16230 16231 16232 16233 16234 16235 16236 16237 16238 16239 16240 16241 16242 16243 16244 16245 16246 16247 16248 16249 16250 16251 16252 16253 16254 16255 16256 16257 16258 16259 16260 16261 16262 16263 16264 |
# File 'lib/oci/core/virtual_network_client.rb', line 16227 def update_remote_peering_connection(remote_peering_connection_id, update_remote_peering_connection_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_remote_peering_connection.' if logger raise "Missing the required parameter 'remote_peering_connection_id' when calling update_remote_peering_connection." if remote_peering_connection_id.nil? raise "Missing the required parameter 'update_remote_peering_connection_details' when calling update_remote_peering_connection." if update_remote_peering_connection_details.nil? raise "Parameter value for 'remote_peering_connection_id' must not be blank" if OCI::Internal::Util.blank_string?(remote_peering_connection_id) path = '/remotePeeringConnections/{remotePeeringConnectionId}'.sub('{remotePeeringConnectionId}', remote_peering_connection_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_remote_peering_connection_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_remote_peering_connection') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::RemotePeeringConnection' ) end # rubocop:enable Metrics/BlockLength end |
#update_route_table(rt_id, update_route_table_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_route_table API.
Updates the specified route table's display name or route rules. Avoid entering confidential information.
Note that the routeRules
object you provide replaces the entire existing set of rules.
16290 16291 16292 16293 16294 16295 16296 16297 16298 16299 16300 16301 16302 16303 16304 16305 16306 16307 16308 16309 16310 16311 16312 16313 16314 16315 16316 16317 16318 16319 16320 16321 16322 16323 16324 16325 16326 16327 |
# File 'lib/oci/core/virtual_network_client.rb', line 16290 def update_route_table(rt_id, update_route_table_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_route_table.' if logger raise "Missing the required parameter 'rt_id' when calling update_route_table." if rt_id.nil? raise "Missing the required parameter 'update_route_table_details' when calling update_route_table." if update_route_table_details.nil? raise "Parameter value for 'rt_id' must not be blank" if OCI::Internal::Util.blank_string?(rt_id) path = '/routeTables/{rtId}'.sub('{rtId}', rt_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_route_table_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_route_table') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::RouteTable' ) end # rubocop:enable Metrics/BlockLength end |
#update_security_list(security_list_id, update_security_list_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_security_list API.
Updates the specified security list's display name or rules. Avoid entering confidential information.
Note that the egressSecurityRules
or ingressSecurityRules
objects you provide replace the entire existing objects.
16354 16355 16356 16357 16358 16359 16360 16361 16362 16363 16364 16365 16366 16367 16368 16369 16370 16371 16372 16373 16374 16375 16376 16377 16378 16379 16380 16381 16382 16383 16384 16385 16386 16387 16388 16389 16390 16391 |
# File 'lib/oci/core/virtual_network_client.rb', line 16354 def update_security_list(security_list_id, update_security_list_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_security_list.' if logger raise "Missing the required parameter 'security_list_id' when calling update_security_list." if security_list_id.nil? raise "Missing the required parameter 'update_security_list_details' when calling update_security_list." if update_security_list_details.nil? raise "Parameter value for 'security_list_id' must not be blank" if OCI::Internal::Util.blank_string?(security_list_id) path = '/securityLists/{securityListId}'.sub('{securityListId}', security_list_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_security_list_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_security_list') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::SecurityList' ) end # rubocop:enable Metrics/BlockLength end |
#update_service_gateway(service_gateway_id, update_service_gateway_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_service_gateway API.
Updates the specified service gateway. The information you provide overwrites the existing attributes of the gateway.
16415 16416 16417 16418 16419 16420 16421 16422 16423 16424 16425 16426 16427 16428 16429 16430 16431 16432 16433 16434 16435 16436 16437 16438 16439 16440 16441 16442 16443 16444 16445 16446 16447 16448 16449 16450 16451 16452 |
# File 'lib/oci/core/virtual_network_client.rb', line 16415 def update_service_gateway(service_gateway_id, update_service_gateway_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_service_gateway.' if logger raise "Missing the required parameter 'service_gateway_id' when calling update_service_gateway." if service_gateway_id.nil? raise "Missing the required parameter 'update_service_gateway_details' when calling update_service_gateway." if update_service_gateway_details.nil? raise "Parameter value for 'service_gateway_id' must not be blank" if OCI::Internal::Util.blank_string?(service_gateway_id) path = '/serviceGateways/{serviceGatewayId}'.sub('{serviceGatewayId}', service_gateway_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_service_gateway_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_service_gateway') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::ServiceGateway' ) end # rubocop:enable Metrics/BlockLength end |
#update_subnet(subnet_id, update_subnet_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_subnet API.
Updates the specified subnet.
16475 16476 16477 16478 16479 16480 16481 16482 16483 16484 16485 16486 16487 16488 16489 16490 16491 16492 16493 16494 16495 16496 16497 16498 16499 16500 16501 16502 16503 16504 16505 16506 16507 16508 16509 16510 16511 16512 |
# File 'lib/oci/core/virtual_network_client.rb', line 16475 def update_subnet(subnet_id, update_subnet_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_subnet.' if logger raise "Missing the required parameter 'subnet_id' when calling update_subnet." if subnet_id.nil? raise "Missing the required parameter 'update_subnet_details' when calling update_subnet." if update_subnet_details.nil? raise "Parameter value for 'subnet_id' must not be blank" if OCI::Internal::Util.blank_string?(subnet_id) path = '/subnets/{subnetId}'.sub('{subnetId}', subnet_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_subnet_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_subnet') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Subnet' ) end # rubocop:enable Metrics/BlockLength end |
#update_tunnel_cpe_device_config(ipsc_id, tunnel_id, update_tunnel_cpe_device_config_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_tunnel_cpe_device_config API.
Creates or updates the set of CPE configuration answers for the specified tunnel. The answers correlate to the questions that are specific to the CPE device type (see the parameters
attribute of CpeDeviceShapeDetail).
16547 16548 16549 16550 16551 16552 16553 16554 16555 16556 16557 16558 16559 16560 16561 16562 16563 16564 16565 16566 16567 16568 16569 16570 16571 16572 16573 16574 16575 16576 16577 16578 16579 16580 16581 16582 16583 16584 16585 16586 16587 16588 16589 |
# File 'lib/oci/core/virtual_network_client.rb', line 16547 def update_tunnel_cpe_device_config(ipsc_id, tunnel_id, update_tunnel_cpe_device_config_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_tunnel_cpe_device_config.' if logger raise "Missing the required parameter 'ipsc_id' when calling update_tunnel_cpe_device_config." if ipsc_id.nil? raise "Missing the required parameter 'tunnel_id' when calling update_tunnel_cpe_device_config." if tunnel_id.nil? raise "Missing the required parameter 'update_tunnel_cpe_device_config_details' when calling update_tunnel_cpe_device_config." if update_tunnel_cpe_device_config_details.nil? raise "Parameter value for 'ipsc_id' must not be blank" if OCI::Internal::Util.blank_string?(ipsc_id) raise "Parameter value for 'tunnel_id' must not be blank" if OCI::Internal::Util.blank_string?(tunnel_id) path = '/ipsecConnections/{ipscId}/tunnels/{tunnelId}/tunnelDeviceConfig'.sub('{ipscId}', ipsc_id.to_s).sub('{tunnelId}', tunnel_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = @api_client.object_to_http_body(update_tunnel_cpe_device_config_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_tunnel_cpe_device_config') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::TunnelCpeDeviceConfig' ) end # rubocop:enable Metrics/BlockLength end |
#update_vcn(vcn_id, update_vcn_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_vcn API.
Updates the specified VCN.
16612 16613 16614 16615 16616 16617 16618 16619 16620 16621 16622 16623 16624 16625 16626 16627 16628 16629 16630 16631 16632 16633 16634 16635 16636 16637 16638 16639 16640 16641 16642 16643 16644 16645 16646 16647 16648 16649 |
# File 'lib/oci/core/virtual_network_client.rb', line 16612 def update_vcn(vcn_id, update_vcn_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_vcn.' if logger raise "Missing the required parameter 'vcn_id' when calling update_vcn." if vcn_id.nil? raise "Missing the required parameter 'update_vcn_details' when calling update_vcn." if update_vcn_details.nil? raise "Parameter value for 'vcn_id' must not be blank" if OCI::Internal::Util.blank_string?(vcn_id) path = '/vcns/{vcnId}'.sub('{vcnId}', vcn_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_vcn_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vcn') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vcn' ) end # rubocop:enable Metrics/BlockLength end |
#update_virtual_circuit(virtual_circuit_id, update_virtual_circuit_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_virtual_circuit API.
Updates the specified virtual circuit. This can be called by either the customer who owns the virtual circuit, or the provider (when provisioning or de-provisioning the virtual circuit from their end). The documentation for update_virtual_circuit_details indicates who can update each property of the virtual circuit.
Important: If the virtual circuit is working and in the PROVISIONED state, updating any of the network-related properties (such as the DRG being used, the BGP ASN, and so on) will cause the virtual circuit's state to switch to PROVISIONING and the related BGP session to go down. After Oracle re-provisions the virtual circuit, its state will return to PROVISIONED. Make sure you confirm that the associated BGP session is back up. For more information about the various states and how to test connectivity, see FastConnect Overview.
To change the list of public IP prefixes for a public virtual circuit, use bulk_add_virtual_circuit_public_prefixes and bulk_delete_virtual_circuit_public_prefixes. Updating the list of prefixes does NOT cause the BGP session to go down. However, Oracle must verify the customer's ownership of each added prefix before traffic for that prefix will flow across the virtual circuit.
16695 16696 16697 16698 16699 16700 16701 16702 16703 16704 16705 16706 16707 16708 16709 16710 16711 16712 16713 16714 16715 16716 16717 16718 16719 16720 16721 16722 16723 16724 16725 16726 16727 16728 16729 16730 16731 16732 |
# File 'lib/oci/core/virtual_network_client.rb', line 16695 def update_virtual_circuit(virtual_circuit_id, update_virtual_circuit_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_virtual_circuit.' if logger raise "Missing the required parameter 'virtual_circuit_id' when calling update_virtual_circuit." if virtual_circuit_id.nil? raise "Missing the required parameter 'update_virtual_circuit_details' when calling update_virtual_circuit." if update_virtual_circuit_details.nil? raise "Parameter value for 'virtual_circuit_id' must not be blank" if OCI::Internal::Util.blank_string?(virtual_circuit_id) path = '/virtualCircuits/{virtualCircuitId}'.sub('{virtualCircuitId}', virtual_circuit_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_virtual_circuit_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_virtual_circuit') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::VirtualCircuit' ) end # rubocop:enable Metrics/BlockLength end |
#update_vlan(vlan_id, update_vlan_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_vlan API.
Updates the specified VLAN. Note that this operation might require changes to all the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.
16759 16760 16761 16762 16763 16764 16765 16766 16767 16768 16769 16770 16771 16772 16773 16774 16775 16776 16777 16778 16779 16780 16781 16782 16783 16784 16785 16786 16787 16788 16789 16790 16791 16792 16793 16794 16795 16796 16797 |
# File 'lib/oci/core/virtual_network_client.rb', line 16759 def update_vlan(vlan_id, update_vlan_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_vlan.' if logger raise "Missing the required parameter 'vlan_id' when calling update_vlan." if vlan_id.nil? raise "Missing the required parameter 'update_vlan_details' when calling update_vlan." if update_vlan_details.nil? raise "Parameter value for 'vlan_id' must not be blank" if OCI::Internal::Util.blank_string?(vlan_id) path = '/vlans/{vlanId}'.sub('{vlanId}', vlan_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_vlan_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vlan') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vlan' ) end # rubocop:enable Metrics/BlockLength end |
#update_vnic(vnic_id, update_vnic_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_vnic API.
Updates the specified VNIC.
16820 16821 16822 16823 16824 16825 16826 16827 16828 16829 16830 16831 16832 16833 16834 16835 16836 16837 16838 16839 16840 16841 16842 16843 16844 16845 16846 16847 16848 16849 16850 16851 16852 16853 16854 16855 16856 16857 |
# File 'lib/oci/core/virtual_network_client.rb', line 16820 def update_vnic(vnic_id, update_vnic_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_vnic.' if logger raise "Missing the required parameter 'vnic_id' when calling update_vnic." if vnic_id.nil? raise "Missing the required parameter 'update_vnic_details' when calling update_vnic." if update_vnic_details.nil? raise "Parameter value for 'vnic_id' must not be blank" if OCI::Internal::Util.blank_string?(vnic_id) path = '/vnics/{vnicId}'.sub('{vnicId}', vnic_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_vnic_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vnic') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vnic' ) end # rubocop:enable Metrics/BlockLength end |
#update_vtap(vtap_id, update_vtap_details, opts = {}) ⇒ Response
Click here to see an example of how to use update_vtap API.
Updates the specified VTAP's display name or tags.
16883 16884 16885 16886 16887 16888 16889 16890 16891 16892 16893 16894 16895 16896 16897 16898 16899 16900 16901 16902 16903 16904 16905 16906 16907 16908 16909 16910 16911 16912 16913 16914 16915 16916 16917 16918 16919 16920 16921 |
# File 'lib/oci/core/virtual_network_client.rb', line 16883 def update_vtap(vtap_id, update_vtap_details, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#update_vtap.' if logger raise "Missing the required parameter 'vtap_id' when calling update_vtap." if vtap_id.nil? raise "Missing the required parameter 'update_vtap_details' when calling update_vtap." if update_vtap_details.nil? raise "Parameter value for 'vtap_id' must not be blank" if OCI::Internal::Util.blank_string?(vtap_id) path = '/vtaps/{vtapId}'.sub('{vtapId}', vtap_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'if-match'] = opts[:if_match] if opts[:if_match] header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = @api_client.object_to_http_body(update_vtap_details) # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#update_vtap') do @api_client.call_api( :PUT, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body, return_type: 'OCI::Core::Models::Vtap' ) end # rubocop:enable Metrics/BlockLength end |
#upgrade_drg(drg_id, opts = {}) ⇒ Response
Click here to see an example of how to use upgrade_drg API.
Upgrades the DRG. After upgrade, you can control routing inside your DRG via DRG attachments, route distributions, and DRG route tables.
16949 16950 16951 16952 16953 16954 16955 16956 16957 16958 16959 16960 16961 16962 16963 16964 16965 16966 16967 16968 16969 16970 16971 16972 16973 16974 16975 16976 16977 16978 16979 16980 16981 16982 16983 16984 16985 16986 |
# File 'lib/oci/core/virtual_network_client.rb', line 16949 def upgrade_drg(drg_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#upgrade_drg.' if logger raise "Missing the required parameter 'drg_id' when calling upgrade_drg." if drg_id.nil? raise "Parameter value for 'drg_id' must not be blank" if OCI::Internal::Util.blank_string?(drg_id) path = '/drgs/{drgId}/actions/upgrade'.sub('{drgId}', drg_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] header_params[:'opc-retry-token'] = opts[:opc_retry_token] if opts[:opc_retry_token] # rubocop:enable Style/NegatedIf header_params[:'opc-retry-token'] ||= OCI::Retry.generate_opc_retry_token post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#upgrade_drg') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#validate_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Click here to see an example of how to use validate_byoip_range API.
Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already modified the information for the BYOIP CIDR block with your Regional Internet Registry. See To import a CIDR block for details.
17008 17009 17010 17011 17012 17013 17014 17015 17016 17017 17018 17019 17020 17021 17022 17023 17024 17025 17026 17027 17028 17029 17030 17031 17032 17033 17034 17035 17036 17037 17038 17039 17040 17041 17042 17043 |
# File 'lib/oci/core/virtual_network_client.rb', line 17008 def validate_byoip_range(byoip_range_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#validate_byoip_range.' if logger raise "Missing the required parameter 'byoip_range_id' when calling validate_byoip_range." if byoip_range_id.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}/actions/validate'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#validate_byoip_range') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |
#withdraw_byoip_range(byoip_range_id, opts = {}) ⇒ Response
Click here to see an example of how to use withdraw_byoip_range API.
Withdraws BGP route advertisement for the BYOIP CIDR block.
17064 17065 17066 17067 17068 17069 17070 17071 17072 17073 17074 17075 17076 17077 17078 17079 17080 17081 17082 17083 17084 17085 17086 17087 17088 17089 17090 17091 17092 17093 17094 17095 17096 17097 17098 17099 |
# File 'lib/oci/core/virtual_network_client.rb', line 17064 def withdraw_byoip_range(byoip_range_id, opts = {}) logger.debug 'Calling operation VirtualNetworkClient#withdraw_byoip_range.' if logger raise "Missing the required parameter 'byoip_range_id' when calling withdraw_byoip_range." if byoip_range_id.nil? raise "Parameter value for 'byoip_range_id' must not be blank" if OCI::Internal::Util.blank_string?(byoip_range_id) path = '/byoipRanges/{byoipRangeId}/actions/withdraw'.sub('{byoipRangeId}', byoip_range_id.to_s) operation_signing_strategy = :standard # rubocop:disable Style/NegatedIf # Query Params query_params = {} # Header Params header_params = {} header_params[:accept] = 'application/json' header_params[:'content-type'] = 'application/json' header_params[:'opc-request-id'] = opts[:opc_request_id] if opts[:opc_request_id] # rubocop:enable Style/NegatedIf post_body = nil # rubocop:disable Metrics/BlockLength OCI::Retry.(applicable_retry_config(opts), call_name: 'VirtualNetworkClient#withdraw_byoip_range') do @api_client.call_api( :POST, path, endpoint, header_params: header_params, query_params: query_params, operation_signing_strategy: operation_signing_strategy, body: post_body ) end # rubocop:enable Metrics/BlockLength end |