VirtualNetworkClient

class oci.core.VirtualNetworkClient(config, **kwargs)

API covering the [Networking](/iaas/Content/Network/Concepts/overview.htm), [Compute](/iaas/Content/Compute/Concepts/computeoverview.htm), and [Block Volume](/iaas/Content/Block/Concepts/overview.htm) services. Use this API to manage resources such as virtual cloud networks (VCNs), compute instances, and block storage volumes.

Methods

__init__(config, **kwargs) Creates a new service client
add_drg_route_distribution_statements(…) Adds one or more route distribution statements to the specified route distribution.
add_drg_route_rules(drg_route_table_id, …) Adds one or more static route rules to the specified DRG route table.
add_ipv6_vcn_cidr(vcn_id, **kwargs) Add an IPv6 CIDR to a VCN.
add_network_security_group_security_rules(…) Adds one or more security rules to the specified network security group.
add_public_ip_pool_capacity(…) Adds some or all of a CIDR block to a public IP pool.
add_vcn_cidr(vcn_id, add_vcn_cidr_details, …) Adds a CIDR block to a VCN.
advertise_byoip_range(byoip_range_id, **kwargs) Begins BGP route advertisements for the BYOIP CIDR block you imported to the Oracle Cloud.
attach_service_id(service_gateway_id, …) Adds the specified Service to the list of enabled Service objects for the specified gateway.
bulk_add_virtual_circuit_public_prefixes(…) Adds one or more customer public IP prefixes to the specified public virtual circuit.
bulk_delete_virtual_circuit_public_prefixes(…) Removes one or more customer public IP prefixes from the specified public virtual circuit.
change_byoip_range_compartment(…) Moves a BYOIP CIDR block to a different compartment.
change_cpe_compartment(cpe_id, …) Moves a CPE object into a different compartment within the same tenancy.
change_cross_connect_compartment(…) Moves a cross-connect into a different compartment within the same tenancy.
change_cross_connect_group_compartment(…) Moves a cross-connect group into a different compartment within the same tenancy.
change_dhcp_options_compartment(dhcp_id, …) Moves a set of DHCP options into a different compartment within the same tenancy.
change_drg_compartment(drg_id, …) Moves a DRG into a different compartment within the same tenancy.
change_internet_gateway_compartment(ig_id, …) Moves an internet gateway into a different compartment within the same tenancy.
change_ip_sec_connection_compartment(…) Moves an IPSec connection into a different compartment within the same tenancy.
change_local_peering_gateway_compartment(…) Moves a local peering gateway into a different compartment within the same tenancy.
change_nat_gateway_compartment(…) Moves a NAT gateway into a different compartment within the same tenancy.
change_network_security_group_compartment(…) Moves a network security group into a different compartment within the same tenancy.
change_public_ip_compartment(public_ip_id, …) Moves a public IP into a different compartment within the same tenancy.
change_public_ip_pool_compartment(…) Moves a public IP pool to a different compartment.
change_remote_peering_connection_compartment(…) Moves a remote peering connection (RPC) into a different compartment within the same tenancy.
change_route_table_compartment(rt_id, …) Moves a route table into a different compartment within the same tenancy.
change_security_list_compartment(…) Moves a security list into a different compartment within the same tenancy.
change_service_gateway_compartment(…) Moves a service gateway into a different compartment within the same tenancy.
change_subnet_compartment(subnet_id, …) Moves a subnet into a different compartment within the same tenancy.
change_vcn_compartment(vcn_id, …) Moves a VCN into a different compartment within the same tenancy.
change_virtual_circuit_compartment(…) Moves a virtual circuit into a different compartment within the same tenancy.
change_vlan_compartment(vlan_id, …) Moves a VLAN into a different compartment within the same tenancy.
connect_local_peering_gateways(…) Connects this local peering gateway (LPG) to another one in the same region.
connect_remote_peering_connections(…) Connects this RPC to another one in a different region.
create_byoip_range(…) Creates a subrange of the BYOIP CIDR block.
create_cpe(create_cpe_details, **kwargs) Creates a new virtual customer-premises equipment (CPE) object in the specified compartment.
create_cross_connect(…) Creates a new cross-connect.
create_cross_connect_group(…) Creates a new cross-connect group to use with Oracle Cloud Infrastructure FastConnect.
create_dhcp_options(create_dhcp_details, …) Creates a new set of DHCP options for the specified VCN.
create_drg(create_drg_details, **kwargs) Creates a new dynamic routing gateway (DRG) in the specified compartment.
create_drg_attachment(…) Attaches the specified DRG to the specified network resource.
create_drg_route_distribution(…) Creates a new route distribution for the specified DRG.
create_drg_route_table(…) Creates a new DRG route table for the specified DRG.
create_internet_gateway(…) Creates a new internet gateway for the specified VCN.
create_ip_sec_connection(…) Creates a new IPSec connection between the specified DRG and CPE.
create_ipv6(create_ipv6_details, **kwargs) Creates an IPv6 for the specified VNIC.
create_local_peering_gateway(…) Creates a new local peering gateway (LPG) for the specified VCN.
create_nat_gateway(…) Creates a new NAT gateway for the specified VCN.
create_network_security_group(…) Creates a new network security group for the specified VCN.
create_private_ip(create_private_ip_details, …) Creates a secondary private IP for the specified VNIC.
create_public_ip(create_public_ip_details, …) Creates a public IP.
create_public_ip_pool(…) Creates a public IP pool.
create_remote_peering_connection(…) Creates a new remote peering connection (RPC) for the specified DRG.
create_route_table(…) Creates a new route table for the specified VCN.
create_security_list(…) Creates a new security list for the specified VCN.
create_service_gateway(…) Creates a new service gateway in the specified compartment.
create_subnet(create_subnet_details, **kwargs) Creates a new subnet in the specified VCN.
create_vcn(create_vcn_details, **kwargs) Creates a new virtual cloud network (VCN).
create_virtual_circuit(…) Creates a new virtual circuit to use with Oracle Cloud Infrastructure FastConnect.
create_vlan(create_vlan_details, **kwargs) Creates a VLAN in the specified VCN and the specified compartment.
delete_byoip_range(byoip_range_id, **kwargs) Deletes the specified ByoipRange resource.
delete_cpe(cpe_id, **kwargs) Deletes the specified CPE object.
delete_cross_connect(cross_connect_id, **kwargs) Deletes the specified cross-connect.
delete_cross_connect_group(…) Deletes the specified cross-connect group.
delete_dhcp_options(dhcp_id, **kwargs) Deletes the specified set of DHCP options, but only if it’s not associated with a subnet.
delete_drg(drg_id, **kwargs) Deletes the specified DRG.
delete_drg_attachment(drg_attachment_id, …) Detaches a DRG from a network resource by deleting the corresponding DrgAttachment resource.
delete_drg_route_distribution(…) Deletes the specified route distribution.
delete_drg_route_table(drg_route_table_id, …) Deletes the specified DRG route table.
delete_internet_gateway(ig_id, **kwargs) Deletes the specified internet gateway.
delete_ip_sec_connection(ipsc_id, **kwargs) Deletes the specified IPSec connection.
delete_ipv6(ipv6_id, **kwargs) Unassigns and deletes the specified IPv6.
delete_local_peering_gateway(…) Deletes the specified local peering gateway (LPG).
delete_nat_gateway(nat_gateway_id, **kwargs) Deletes the specified NAT gateway.
delete_network_security_group(…) Deletes the specified network security group.
delete_private_ip(private_ip_id, **kwargs) Unassigns and deletes the specified private IP.
delete_public_ip(public_ip_id, **kwargs) Unassigns and deletes the specified public IP (either ephemeral or reserved).
delete_public_ip_pool(public_ip_pool_id, …) Deletes the specified public IP pool.
delete_remote_peering_connection(…) Deletes the remote peering connection (RPC).
delete_route_table(rt_id, **kwargs) Deletes the specified route table, but only if it’s not associated with a subnet.
delete_security_list(security_list_id, **kwargs) Deletes the specified security list, but only if it’s not associated with a subnet.
delete_service_gateway(service_gateway_id, …) Deletes the specified service gateway.
delete_subnet(subnet_id, **kwargs) Deletes the specified subnet, but only if there are no instances in the subnet.
delete_vcn(vcn_id, **kwargs) Deletes the specified VCN.
delete_virtual_circuit(virtual_circuit_id, …) Deletes the specified virtual circuit.
delete_vlan(vlan_id, **kwargs) Deletes the specified VLAN, but only if there are no VNICs in the VLAN.
detach_service_id(service_gateway_id, …) Removes the specified Service from the list of enabled Service objects for the specified gateway.
get_all_drg_attachments(drg_id, **kwargs) Returns a complete list of DRG attachments that belong to a particular DRG.
get_byoip_range(byoip_range_id, **kwargs) Gets the ByoipRange resource.
get_cpe(cpe_id, **kwargs) Gets the specified CPE’s information.
get_cpe_device_config_content(cpe_id, **kwargs) 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, …) Gets the detailed information about the specified CPE device type.
get_cross_connect(cross_connect_id, **kwargs) Gets the specified cross-connect’s information.
get_cross_connect_group(…) Gets the specified cross-connect group’s information.
get_cross_connect_letter_of_authority(…) Gets the Letter of Authority for the specified cross-connect.
get_cross_connect_status(cross_connect_id, …) Gets the status of the specified cross-connect.
get_dhcp_options(dhcp_id, **kwargs) Gets the specified set of DHCP options.
get_drg(drg_id, **kwargs) Gets the specified DRG’s information.
get_drg_attachment(drg_attachment_id, **kwargs) Gets the DrgAttachment resource.
get_drg_redundancy_status(drg_id, **kwargs) Gets the redundancy status for the specified DRG.
get_drg_route_distribution(…) Gets the specified route distribution’s information.
get_drg_route_table(drg_route_table_id, **kwargs) Gets the specified DRG route table’s information.
get_fast_connect_provider_service(…) Gets the specified provider service.
get_fast_connect_provider_service_key(…) Gets the specified provider service key’s information.
get_internet_gateway(ig_id, **kwargs) Gets the specified internet gateway’s information.
get_ip_sec_connection(ipsc_id, **kwargs) 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, …) Deprecated.
get_ip_sec_connection_device_status(ipsc_id, …) Deprecated.
get_ip_sec_connection_tunnel(ipsc_id, …) Gets the specified tunnel’s information.
get_ip_sec_connection_tunnel_shared_secret(…) Gets the specified tunnel’s shared secret (pre-shared key).
get_ipsec_cpe_device_config_content(ipsc_id, …) Renders a set of CPE configuration content for the specified IPSec connection (for all the tunnels in the connection).
get_ipv6(ipv6_id, **kwargs) Gets the specified IPv6.
get_local_peering_gateway(…) Gets the specified local peering gateway’s information.
get_nat_gateway(nat_gateway_id, **kwargs) Gets the specified NAT gateway’s information.
get_network_security_group(…) Gets the specified network security group’s information.
get_networking_topology(compartment_id, **kwargs) Gets a virtual networking topology for the current region.
get_private_ip(private_ip_id, **kwargs) Gets the specified private IP.
get_public_ip(public_ip_id, **kwargs) Gets the specified public IP.
get_public_ip_by_ip_address(…) Gets the public IP based on the public IP address (for example, 203.0.113.2).
get_public_ip_by_private_ip_id(…) Gets the public IP assigned to the specified private IP.
get_public_ip_pool(public_ip_pool_id, **kwargs) Gets the specified PublicIpPool object.
get_remote_peering_connection(…) Get the specified remote peering connection’s information.
get_route_table(rt_id, **kwargs) Gets the specified route table’s information.
get_security_list(security_list_id, **kwargs) Gets the specified security list’s information.
get_service(service_id, **kwargs) Gets the specified Service object.
get_service_gateway(service_gateway_id, **kwargs) Gets the specified service gateway’s information.
get_subnet(subnet_id, **kwargs) Gets the specified subnet’s information.
get_tunnel_cpe_device_config(ipsc_id, …) 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(…) Renders a set of CPE configuration content for the specified IPSec tunnel.
get_upgrade_status(drg_id, **kwargs) Returns the DRG upgrade status.
get_vcn(vcn_id, **kwargs) Gets the specified VCN’s information.
get_vcn_dns_resolver_association(vcn_id, …) Get the associated DNS resolver information with a vcn
get_vcn_topology(compartment_id, vcn_id, …) Gets a virtual network topology for a given VCN.
get_virtual_circuit(virtual_circuit_id, **kwargs) Gets the specified virtual circuit’s information.
get_vlan(vlan_id, **kwargs) Gets the specified VLAN’s information.
get_vnic(vnic_id, **kwargs) Gets the information for the specified virtual network interface card (VNIC).
list_allowed_peer_regions_for_remote_peering(…) Lists the regions that support remote VCN peering (which is peering across regions).
list_byoip_allocated_ranges(byoip_range_id, …) Lists the subranges of a BYOIP CIDR block currently allocated to an IP pool.
list_byoip_ranges(compartment_id, **kwargs) Lists the ByoipRange resources in the specified compartment.
list_cpe_device_shapes(**kwargs) Lists the CPE device types that the Networking service provides CPE configuration content for (example: Cisco ASA).
list_cpes(compartment_id, **kwargs) Lists the customer-premises equipment objects (CPEs) in the specified compartment.
list_cross_connect_groups(compartment_id, …) Lists the cross-connect groups in the specified compartment.
list_cross_connect_locations(compartment_id, …) Lists the available FastConnect locations for cross-connect installation.
list_cross_connect_mappings(…) Lists the Cross Connect mapping Details for the specified virtual circuit.
list_cross_connects(compartment_id, **kwargs) Lists the cross-connects in the specified compartment.
list_crossconnect_port_speed_shapes(…) Lists the available port speeds for cross-connects.
list_dhcp_options(compartment_id, **kwargs) Lists the sets of DHCP options in the specified VCN and specified compartment.
list_drg_attachments(compartment_id, **kwargs) Lists the DrgAttachment resource for the specified compartment.
list_drg_route_distribution_statements(…) Lists the statements for the specified route distribution.
list_drg_route_distributions(drg_id, **kwargs) Lists the route distributions in the specified DRG.
list_drg_route_rules(drg_route_table_id, …) Lists the route rules in the specified DRG route table.
list_drg_route_tables(drg_id, **kwargs) Lists the DRG route tables for the specified DRG.
list_drgs(compartment_id, **kwargs) Lists the DRGs in the specified compartment.
list_fast_connect_provider_services(…) Lists the service offerings from supported providers.
list_fast_connect_provider_virtual_circuit_bandwidth_shapes(…) Gets the list of available virtual circuit bandwidth levels for a provider.
list_internet_gateways(compartment_id, **kwargs) Lists the internet gateways in the specified VCN and the specified compartment.
list_ip_sec_connection_tunnels(ipsc_id, **kwargs) Lists the tunnel information for the specified IPSec connection.
list_ip_sec_connections(compartment_id, **kwargs) Lists the IPSec connections for the specified compartment.
list_ipv6s(**kwargs) Lists the Ipv6 objects based
list_local_peering_gateways(compartment_id, …) Lists the local peering gateways (LPGs) for the specified VCN and specified compartment.
list_nat_gateways(compartment_id, **kwargs) Lists the NAT gateways in the specified compartment.
list_network_security_group_security_rules(…) Lists the security rules in the specified network security group.
list_network_security_group_vnics(…) Lists the VNICs in the specified network security group.
list_network_security_groups(**kwargs) Lists either the network security groups in the specified compartment, or those associated with the specified VLAN.
list_private_ips(**kwargs) Lists the PrivateIp objects based
list_public_ip_pools(compartment_id, **kwargs) Lists the public IP pools in the specified compartment.
list_public_ips(scope, compartment_id, **kwargs) Lists the PublicIp objects in the specified compartment.
list_remote_peering_connections(…) Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC’s compartment).
list_route_tables(compartment_id, **kwargs) Lists the route tables in the specified VCN and specified compartment.
list_security_lists(compartment_id, **kwargs) Lists the security lists in the specified VCN and compartment.
list_service_gateways(compartment_id, **kwargs) Lists the service gateways in the specified compartment.
list_services(**kwargs) Lists the available Service objects that you can enable for a service gateway in this region.
list_subnets(compartment_id, **kwargs) Lists the subnets in the specified VCN and the specified compartment.
list_vcns(compartment_id, **kwargs) Lists the virtual cloud networks (VCNs) in the specified compartment.
list_virtual_circuit_bandwidth_shapes(…) The deprecated operation lists available bandwidth levels for virtual circuits.
list_virtual_circuit_public_prefixes(…) Lists the public IP prefixes and their details for the specified public virtual circuit.
list_virtual_circuits(compartment_id, **kwargs) Lists the virtual circuits in the specified compartment.
list_vlans(compartment_id, **kwargs) Lists the VLANs in the specified VCN and the specified compartment.
modify_vcn_cidr(vcn_id, …) Updates the specified CIDR block of a VCN.
remove_drg_route_distribution_statements(…) Removes one or more route distribution statements from the specified route distribution’s map.
remove_drg_route_rules(drg_route_table_id, …) Removes one or more route rules from the specified DRG route table.
remove_export_drg_route_distribution(…) Removes the export route distribution from the DRG attachment so no routes are advertised to it.
remove_import_drg_route_distribution(…) Removes the import route distribution from the DRG route table so no routes are imported into it.
remove_network_security_group_security_rules(…) Removes one or more security rules from the specified network security group.
remove_public_ip_pool_capacity(…) Removes a CIDR block from the referenced public IP pool.
remove_vcn_cidr(vcn_id, …) Removes a specified CIDR block from a VCN.
update_byoip_range(byoip_range_id, …) Updates the tags or display name associated to the specified BYOIP CIDR block.
update_cpe(cpe_id, update_cpe_details, **kwargs) Updates the specified CPE’s display name or tags.
update_cross_connect(cross_connect_id, …) Updates the specified cross-connect.
update_cross_connect_group(…) Updates the specified cross-connect group’s display name.
update_dhcp_options(dhcp_id, …) Updates the specified set of DHCP options.
update_drg(drg_id, update_drg_details, **kwargs) Updates the specified DRG’s display name or tags.
update_drg_attachment(drg_attachment_id, …) Updates the display name and routing information for the specified DrgAttachment.
update_drg_route_distribution(…) Updates the specified route distribution
update_drg_route_distribution_statements(…) Updates one or more route distribution statements in the specified route distribution.
update_drg_route_rules(drg_route_table_id, …) Updates one or more route rules in the specified DRG route table.
update_drg_route_table(drg_route_table_id, …) Updates the specified DRG route table.
update_internet_gateway(ig_id, …) Updates the specified internet gateway.
update_ip_sec_connection(ipsc_id, …) Updates the specified IPSec connection.
update_ip_sec_connection_tunnel(ipsc_id, …) Updates the specified tunnel.
update_ip_sec_connection_tunnel_shared_secret(…) Updates the shared secret (pre-shared key) for the specified tunnel.
update_ipv6(ipv6_id, update_ipv6_details, …) Updates the specified IPv6.
update_local_peering_gateway(…) Updates the specified local peering gateway (LPG).
update_nat_gateway(nat_gateway_id, …) Updates the specified NAT gateway.
update_network_security_group(…) Updates the specified network security group.
update_network_security_group_security_rules(…) Updates one or more security rules in the specified network security group.
update_private_ip(private_ip_id, …) Updates the specified private IP.
update_public_ip(public_ip_id, …) Updates the specified public IP.
update_public_ip_pool(public_ip_pool_id, …) Updates the specified public IP pool.
update_remote_peering_connection(…) Updates the specified remote peering connection (RPC).
update_route_table(rt_id, …) Updates the specified route table’s display name or route rules.
update_security_list(security_list_id, …) Updates the specified security list’s display name or rules.
update_service_gateway(service_gateway_id, …) Updates the specified service gateway.
update_subnet(subnet_id, …) Updates the specified subnet.
update_tunnel_cpe_device_config(ipsc_id, …) Creates or updates the set of CPE configuration answers for the specified tunnel.
update_vcn(vcn_id, update_vcn_details, **kwargs) Updates the specified VCN.
update_virtual_circuit(virtual_circuit_id, …) Updates the specified virtual circuit.
update_vlan(vlan_id, update_vlan_details, …) Updates the specified VLAN.
update_vnic(vnic_id, update_vnic_details, …) Updates the specified VNIC.
upgrade_drg(drg_id, **kwargs) Upgrades the DRG.
validate_byoip_range(byoip_range_id, **kwargs) Submits the BYOIP CIDR block you are importing for validation.
withdraw_byoip_range(byoip_range_id, **kwargs) Withdraws BGP route advertisement for the BYOIP CIDR block.
__init__(config, **kwargs)

Creates a new service client

Parameters:
  • config (dict) – Configuration keys and values as per SDK and Tool Configuration. The from_file() method can be used to load configuration from a file. Alternatively, a dict can be passed. You can validate_config the dict using validate_config()
  • service_endpoint (str) – (optional) The endpoint of the service to call using this client. For example https://iaas.us-ashburn-1.oraclecloud.com. If this keyword argument is not provided then it will be derived using the region in the config parameter. You should only provide this keyword argument if you have an explicit need to specify a service endpoint.
  • timeout (float or tuple(float, float)) – (optional) The connection and read timeouts for the client. The default values are connection timeout 10 seconds and read timeout 60 seconds. This keyword argument can be provided as a single float, in which case the value provided is used for both the read and connection timeouts, or as a tuple of two floats. If a tuple is provided then the first value is used as the connection timeout and the second value as the read timeout.
  • signer (AbstractBaseSigner) –

    (optional) The signer to use when signing requests made by the service client. The default is to use a Signer based on the values provided in the config parameter.

    One use case for this parameter is for Instance Principals authentication by passing an instance of InstancePrincipalsSecurityTokenSigner as the value for this keyword argument

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to all calls made by this service client (i.e. at the client level). There is no retry strategy applied by default. Retry strategies can also be applied at the operation level by passing a retry_strategy keyword argument as part of calling the operation. Any value provided at the operation level will override whatever is specified at the client level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

add_drg_route_distribution_statements(drg_route_distribution_id, add_drg_route_distribution_statements_details, **kwargs)

Adds one or more route distribution statements to the specified route distribution.

Parameters:
  • drg_route_distribution_id (str) –

    (required) The OCID of the route distribution.

  • add_drg_route_distribution_statements_details (oci.core.models.AddDrgRouteDistributionStatementsDetails) – (required) Request with one or more route distribution statements to be inserted into the route distribution.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteDistributionStatement

Return type:

Response

Example:

Click here to see an example of how to use add_drg_route_distribution_statements API.

add_drg_route_rules(drg_route_table_id, add_drg_route_rules_details, **kwargs)

Adds one or more static route rules to the specified DRG route table.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • add_drg_route_rules_details (oci.core.models.AddDrgRouteRulesDetails) – (required) Request for one or more route rules to be inserted into the DRG route table.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteRule

Return type:

Response

Example:

Click here to see an example of how to use add_drg_route_rules API.

add_ipv6_vcn_cidr(vcn_id, **kwargs)

Add an IPv6 CIDR to a VCN. The VCN size is always /56 and assigned by Oracle. Once added the IPv6 CIDR block cannot be removed or modified.

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_ipv6_vcn_cidr API.

add_network_security_group_security_rules(network_security_group_id, add_network_security_group_security_rules_details, **kwargs)

Adds one or more security rules to the specified network security group.

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • add_network_security_group_security_rules_details (oci.core.models.AddNetworkSecurityGroupSecurityRulesDetails) – (required) Request with one or more security rules to be associated with the network security group.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type AddedNetworkSecurityGroupSecurityRules

Return type:

Response

Example:

Click here to see an example of how to use add_network_security_group_security_rules API.

add_public_ip_pool_capacity(public_ip_pool_id, add_public_ip_pool_capacity_details, **kwargs)

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.

Parameters:
  • public_ip_pool_id (str) –

    (required) The OCID of the public IP pool.

  • add_public_ip_pool_capacity_details (oci.core.models.AddPublicIpPoolCapacityDetails) – (required) Byoip Range prefix and a cidr from it
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIpPool

Return type:

Response

Example:

Click here to see an example of how to use add_public_ip_pool_capacity API.

add_vcn_cidr(vcn_id, add_vcn_cidr_details, **kwargs)

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.

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • add_vcn_cidr_details (oci.core.models.AddVcnCidrDetails) – (required) Details object for deleting a VCN CIDR.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use add_vcn_cidr API.

advertise_byoip_range(byoip_range_id, **kwargs)

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.

Parameters:
  • byoip_range_id (str) –

    (required) The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use advertise_byoip_range API.

attach_service_id(service_gateway_id, attach_service_details, **kwargs)

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.

Parameters:
  • service_gateway_id (str) –

    (required) The service gateway’s OCID.

  • attach_service_details (oci.core.models.ServiceIdRequestDetails) – (required) ServiceId of Service to be attached to a service gateway.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceGateway

Return type:

Response

Example:

Click here to see an example of how to use attach_service_id API.

bulk_add_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_add_virtual_circuit_public_prefixes_details, **kwargs)

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.

Parameters:
  • virtual_circuit_id (str) –

    (required) The OCID of the virtual circuit.

  • bulk_add_virtual_circuit_public_prefixes_details (oci.core.models.BulkAddVirtualCircuitPublicPrefixesDetails) – (required) Request with publix prefixes to be added to the virtual circuit
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use bulk_add_virtual_circuit_public_prefixes API.

bulk_delete_virtual_circuit_public_prefixes(virtual_circuit_id, bulk_delete_virtual_circuit_public_prefixes_details, **kwargs)

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.

Parameters:
  • virtual_circuit_id (str) –

    (required) The OCID of the virtual circuit.

  • bulk_delete_virtual_circuit_public_prefixes_details (oci.core.models.BulkDeleteVirtualCircuitPublicPrefixesDetails) – (required) Request with public prefixes to be deleted from the virtual circuit.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use bulk_delete_virtual_circuit_public_prefixes API.

change_byoip_range_compartment(byoip_range_id, change_byoip_range_compartment_details, **kwargs)

Moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:
  • byoip_range_id (str) –

    (required) The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • change_byoip_range_compartment_details (oci.core.models.ChangeByoipRangeCompartmentDetails) – (required) Request to change the compartment of a BYOIP CIDR block.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_byoip_range_compartment API.

change_cpe_compartment(cpe_id, change_cpe_compartment_details, **kwargs)

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.

Parameters:
  • cpe_id (str) –

    (required) The OCID of the CPE.

  • change_cpe_compartment_details (oci.core.models.ChangeCpeCompartmentDetails) – (required) Request to change the compartment of a CPE.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_cpe_compartment API.

change_cross_connect_compartment(cross_connect_id, change_cross_connect_compartment_details, **kwargs)

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.

Parameters:
  • cross_connect_id (str) –

    (required) The OCID of the cross-connect.

  • change_cross_connect_compartment_details (oci.core.models.ChangeCrossConnectCompartmentDetails) – (required) Request to change the compartment of a Cross Connect.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_cross_connect_compartment API.

change_cross_connect_group_compartment(cross_connect_group_id, change_cross_connect_group_compartment_details, **kwargs)

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.

Parameters:
  • cross_connect_group_id (str) –

    (required) The OCID of the cross-connect group.

  • change_cross_connect_group_compartment_details (oci.core.models.ChangeCrossConnectGroupCompartmentDetails) – (required) Request to change the compartment of a Cross Connect Group.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_cross_connect_group_compartment API.

change_dhcp_options_compartment(dhcp_id, change_dhcp_options_compartment_details, **kwargs)

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.

Parameters:
  • dhcp_id (str) –

    (required) The OCID for the set of DHCP options.

  • change_dhcp_options_compartment_details (oci.core.models.ChangeDhcpOptionsCompartmentDetails) – (required) Request to change the compartment of a set of DHCP Options.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_dhcp_options_compartment API.

change_drg_compartment(drg_id, change_drg_compartment_details, **kwargs)

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.

Parameters:
  • drg_id (str) –

    (required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.

  • change_drg_compartment_details (oci.core.models.ChangeDrgCompartmentDetails) – (required) Request to change the compartment of a DRG.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_drg_compartment API.

change_internet_gateway_compartment(ig_id, change_internet_gateway_compartment_details, **kwargs)

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.

Parameters:
  • ig_id (str) –

    (required) The OCID of the internet gateway.

  • change_internet_gateway_compartment_details (oci.core.models.ChangeInternetGatewayCompartmentDetails) – (required) Request to change the compartment of an internet gateway.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_internet_gateway_compartment API.

change_ip_sec_connection_compartment(ipsc_id, change_ip_sec_connection_compartment_details, **kwargs)

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.

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • change_ip_sec_connection_compartment_details (oci.core.models.ChangeIPSecConnectionCompartmentDetails) – (required) Request to change the compartment of a IPSec connection.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_ip_sec_connection_compartment API.

change_local_peering_gateway_compartment(local_peering_gateway_id, change_local_peering_gateway_compartment_details, **kwargs)

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.

Parameters:
  • local_peering_gateway_id (str) –

    (required) The OCID of the local peering gateway.

  • change_local_peering_gateway_compartment_details (oci.core.models.ChangeLocalPeeringGatewayCompartmentDetails) – (required) Request to change the compartment of a given local peering gateway.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_local_peering_gateway_compartment API.

change_nat_gateway_compartment(nat_gateway_id, change_nat_gateway_compartment_details, **kwargs)

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.

Parameters:
  • nat_gateway_id (str) –

    (required) The NAT gateway’s OCID.

  • change_nat_gateway_compartment_details (oci.core.models.ChangeNatGatewayCompartmentDetails) – (required) Request to change the compartment of a given NAT Gateway.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_nat_gateway_compartment API.

change_network_security_group_compartment(network_security_group_id, change_network_security_group_compartment_details, **kwargs)

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.

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • change_network_security_group_compartment_details (oci.core.models.ChangeNetworkSecurityGroupCompartmentDetails) – (required) Request to change the compartment of a network security group.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_network_security_group_compartment API.

change_public_ip_compartment(public_ip_id, change_public_ip_compartment_details, **kwargs)

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.

Parameters:
  • public_ip_id (str) –

    (required) The OCID of the public IP.

  • change_public_ip_compartment_details (oci.core.models.ChangePublicIpCompartmentDetails) – (required) Request to change the compartment of a Public IP.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_public_ip_compartment API.

change_public_ip_pool_compartment(public_ip_pool_id, change_public_ip_pool_compartment_details, **kwargs)

Moves a public IP pool to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Parameters:
  • public_ip_pool_id (str) –

    (required) The OCID of the public IP pool.

  • change_public_ip_pool_compartment_details (oci.core.models.ChangePublicIpPoolCompartmentDetails) – (required) Request to change the compartment of a public IP pool.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_public_ip_pool_compartment API.

change_remote_peering_connection_compartment(remote_peering_connection_id, change_remote_peering_connection_compartment_details, **kwargs)

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.

Parameters:
  • remote_peering_connection_id (str) –

    (required) The OCID of the remote peering connection (RPC).

  • change_remote_peering_connection_compartment_details (oci.core.models.ChangeRemotePeeringConnectionCompartmentDetails) – (required) Request to change the compartment of a remote peering connection.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_remote_peering_connection_compartment API.

change_route_table_compartment(rt_id, change_route_table_compartment_details, **kwargs)

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.

Parameters:
  • rt_id (str) –

    (required) The OCID of the route table.

  • change_route_table_compartment_details (oci.core.models.ChangeRouteTableCompartmentDetails) – (required) Request to change the compartment of a given route table.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_route_table_compartment API.

change_security_list_compartment(security_list_id, change_security_list_compartment_details, **kwargs)

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.

Parameters:
  • security_list_id (str) –

    (required) The OCID of the security list.

  • change_security_list_compartment_details (oci.core.models.ChangeSecurityListCompartmentDetails) – (required) Request to change the compartment of a given security list.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_security_list_compartment API.

change_service_gateway_compartment(service_gateway_id, change_service_gateway_compartment_details, **kwargs)

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.

Parameters:
  • service_gateway_id (str) –

    (required) The service gateway’s OCID.

  • change_service_gateway_compartment_details (oci.core.models.ChangeServiceGatewayCompartmentDetails) – (required) Request to change the compartment of a given Service Gateway.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_service_gateway_compartment API.

change_subnet_compartment(subnet_id, change_subnet_compartment_details, **kwargs)

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.

Parameters:
  • subnet_id (str) –

    (required) The OCID of the subnet.

  • change_subnet_compartment_details (oci.core.models.ChangeSubnetCompartmentDetails) – (required) Request to change the compartment of a given subnet.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_subnet_compartment API.

change_vcn_compartment(vcn_id, change_vcn_compartment_details, **kwargs)

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.

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • change_vcn_compartment_details (oci.core.models.ChangeVcnCompartmentDetails) – (required) Request to change the compartment of a given VCN.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_vcn_compartment API.

change_virtual_circuit_compartment(virtual_circuit_id, change_virtual_circuit_compartment_details, **kwargs)

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.

Parameters:
  • virtual_circuit_id (str) –

    (required) The OCID of the virtual circuit.

  • change_virtual_circuit_compartment_details (oci.core.models.ChangeVirtualCircuitCompartmentDetails) – (required) Request to change the compartment of a virtual circuit.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_virtual_circuit_compartment API.

change_vlan_compartment(vlan_id, change_vlan_compartment_details, **kwargs)

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.

Parameters:
  • vlan_id (str) –

    (required) The OCID of the VLAN.

  • change_vlan_compartment_details (oci.core.models.ChangeVlanCompartmentDetails) – (required) Request to change the compartment of a given VLAN.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use change_vlan_compartment API.

connect_local_peering_gateways(local_peering_gateway_id, connect_local_peering_gateways_details, **kwargs)

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.

Parameters:
  • local_peering_gateway_id (str) –

    (required) The OCID of the local peering gateway.

  • connect_local_peering_gateways_details (oci.core.models.ConnectLocalPeeringGatewaysDetails) – (required) Details regarding the local peering gateway to connect.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use connect_local_peering_gateways API.

connect_remote_peering_connections(remote_peering_connection_id, connect_remote_peering_connections_details, **kwargs)

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.

Parameters:
  • remote_peering_connection_id (str) –

    (required) The OCID of the remote peering connection (RPC).

  • connect_remote_peering_connections_details (oci.core.models.ConnectRemotePeeringConnectionsDetails) – (required) Details to connect peering connection with peering connection from remote region
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use connect_remote_peering_connections API.

create_byoip_range(create_byoip_range_details, **kwargs)

Creates a subrange of the BYOIP CIDR block.

Parameters:
  • create_byoip_range_details (oci.core.models.CreateByoipRangeDetails) – (required) Details needed to create a BYOIP CIDR block subrange.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ByoipRange

Return type:

Response

Example:

Click here to see an example of how to use create_byoip_range API.

create_cpe(create_cpe_details, **kwargs)

Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see IPSec VPNs.

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 Configuring Your On-Premises Router for an IPSec VPN.

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.

Parameters:
  • create_cpe_details (oci.core.models.CreateCpeDetails) – (required) Details for creating a CPE.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Cpe

Return type:

Response

Example:

Click here to see an example of how to use create_cpe API.

create_cross_connect(create_cross_connect_details, **kwargs)

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.

Parameters:
  • create_cross_connect_details (oci.core.models.CreateCrossConnectDetails) – (required) Details to create a CrossConnect
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnect

Return type:

Response

Example:

Click here to see an example of how to use create_cross_connect API.

create_cross_connect_group(create_cross_connect_group_details, **kwargs)

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.

Parameters:
  • create_cross_connect_group_details (oci.core.models.CreateCrossConnectGroupDetails) – (required) Details to create a CrossConnectGroup
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnectGroup

Return type:

Response

Example:

Click here to see an example of how to use create_cross_connect_group API.

create_dhcp_options(create_dhcp_details, **kwargs)

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.

Parameters:
  • create_dhcp_details (oci.core.models.CreateDhcpDetails) – (required) Request object for creating a new set of DHCP options.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DhcpOptions

Return type:

Response

Example:

Click here to see an example of how to use create_dhcp_options API.

create_drg(create_drg_details, **kwargs)

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.

Parameters:
  • create_drg_details (oci.core.models.CreateDrgDetails) – (required) Details for creating a DRG.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Drg

Return type:

Response

Example:

Click here to see an example of how to use create_drg API.

create_drg_attachment(create_drg_attachment_details, **kwargs)

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.

Parameters:
  • create_drg_attachment_details (oci.core.models.CreateDrgAttachmentDetails) – (required) Details for creating a DrgAttachment.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgAttachment

Return type:

Response

Example:

Click here to see an example of how to use create_drg_attachment API.

create_drg_route_distribution(create_drg_route_distribution_details, **kwargs)

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.

Parameters:
  • create_drg_route_distribution_details (oci.core.models.CreateDrgRouteDistributionDetails) – (required) Details for creating a route distribution.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRouteDistribution

Return type:

Response

Example:

Click here to see an example of how to use create_drg_route_distribution API.

create_drg_route_table(create_drg_route_table_details, **kwargs)

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.

Parameters:
  • create_drg_route_table_details (oci.core.models.CreateDrgRouteTableDetails) – (required) Details for creating a DRG route table.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRouteTable

Return type:

Response

Example:

Click here to see an example of how to use create_drg_route_table API.

create_internet_gateway(create_internet_gateway_details, **kwargs)

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.

Parameters:
  • create_internet_gateway_details (oci.core.models.CreateInternetGatewayDetails) – (required) Details for creating a new internet gateway.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InternetGateway

Return type:

Response

Example:

Click here to see an example of how to use create_internet_gateway API.

create_ip_sec_connection(create_ip_sec_connection_details, **kwargs)

Creates a new IPSec connection between the specified DRG and CPE. For more information, see IPSec VPNs.

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 Configuring Your On-Premises Router for an IPSec VPN.

Parameters:
  • create_ip_sec_connection_details (oci.core.models.CreateIPSecConnectionDetails) – (required) Details for creating an IPSecConnection.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnection

Return type:

Response

Example:

Click here to see an example of how to use create_ip_sec_connection API.

create_ipv6(create_ipv6_details, **kwargs)

Creates an IPv6 for the specified VNIC.

Parameters:
  • create_ipv6_details (oci.core.models.CreateIpv6Details) – (required) Create IPv6 details.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Ipv6

Return type:

Response

Example:

Click here to see an example of how to use create_ipv6 API.

create_local_peering_gateway(create_local_peering_gateway_details, **kwargs)

Creates a new local peering gateway (LPG) for the specified VCN.

Parameters:
  • create_local_peering_gateway_details (oci.core.models.CreateLocalPeeringGatewayDetails) – (required) Details for creating a new local peering gateway.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LocalPeeringGateway

Return type:

Response

Example:

Click here to see an example of how to use create_local_peering_gateway API.

create_nat_gateway(create_nat_gateway_details, **kwargs)

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.

Parameters:
  • create_nat_gateway_details (oci.core.models.CreateNatGatewayDetails) – (required) Details for creating a NAT gateway.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NatGateway

Return type:

Response

Example:

Click here to see an example of how to use create_nat_gateway API.

create_network_security_group(create_network_security_group_details, **kwargs)

Creates a new network security group for the specified VCN.

Parameters:
  • create_network_security_group_details (oci.core.models.CreateNetworkSecurityGroupDetails) – (required) Details for creating a network security group.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NetworkSecurityGroup

Return type:

Response

Example:

Click here to see an example of how to use create_network_security_group API.

create_private_ip(create_private_ip_details, **kwargs)

Creates a secondary private IP for the specified VNIC. For more information about secondary private IPs, see IP Addresses.

Parameters:
  • create_private_ip_details (oci.core.models.CreatePrivateIpDetails) – (required) Create private IP details.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateIp

Return type:

Response

Example:

Click here to see an example of how to use create_private_ip API.

create_public_ip(create_public_ip_details, **kwargs)

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.

Parameters:
  • create_public_ip_details (oci.core.models.CreatePublicIpDetails) – (required) Create public IP details.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIp

Return type:

Response

Example:

Click here to see an example of how to use create_public_ip API.

create_public_ip_pool(create_public_ip_pool_details, **kwargs)

Creates a public IP pool.

Parameters:
  • create_public_ip_pool_details (oci.core.models.CreatePublicIpPoolDetails) – (required) Create Public Ip Pool details
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIpPool

Return type:

Response

Example:

Click here to see an example of how to use create_public_ip_pool API.

create_remote_peering_connection(create_remote_peering_connection_details, **kwargs)

Creates a new remote peering connection (RPC) for the specified DRG.

Parameters:
  • create_remote_peering_connection_details (oci.core.models.CreateRemotePeeringConnectionDetails) – (required) Request to create peering connection to remote region
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RemotePeeringConnection

Return type:

Response

Example:

Click here to see an example of how to use create_remote_peering_connection API.

create_route_table(create_route_table_details, **kwargs)

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.

Parameters:
  • create_route_table_details (oci.core.models.CreateRouteTableDetails) – (required) Details for creating a new route table.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RouteTable

Return type:

Response

Example:

Click here to see an example of how to use create_route_table API.

create_security_list(create_security_list_details, **kwargs)

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.

Parameters:
  • create_security_list_details (oci.core.models.CreateSecurityListDetails) – (required) Details regarding the security list to create.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SecurityList

Return type:

Response

Example:

Click here to see an example of how to use create_security_list API.

create_service_gateway(create_service_gateway_details, **kwargs)

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.

Parameters:
  • create_service_gateway_details (oci.core.models.CreateServiceGatewayDetails) – (required) Details for creating a service gateway.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceGateway

Return type:

Response

Example:

Click here to see an example of how to use create_service_gateway API.

create_subnet(create_subnet_details, **kwargs)

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.

Parameters:
  • create_subnet_details (oci.core.models.CreateSubnetDetails) – (required) Details for creating a subnet.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Subnet

Return type:

Response

Example:

Click here to see an example of how to use create_subnet API.

create_vcn(create_vcn_details, **kwargs)

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 an IPSec VPN or FastConnect. For more information, see Overview of the Networking Service.

Parameters:
  • create_vcn_details (oci.core.models.CreateVcnDetails) – (required) Details for creating a new VCN.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Vcn

Return type:

Response

Example:

Click here to see an example of how to use create_vcn API.

create_virtual_circuit(create_virtual_circuit_details, **kwargs)

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.

Parameters:
  • create_virtual_circuit_details (oci.core.models.CreateVirtualCircuitDetails) – (required) Details to create a VirtualCircuit.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VirtualCircuit

Return type:

Response

Example:

Click here to see an example of how to use create_virtual_circuit API.

create_vlan(create_vlan_details, **kwargs)

Creates a VLAN in the specified VCN and the specified compartment.

Parameters:
  • create_vlan_details (oci.core.models.CreateVlanDetails) – (required) Details for creating a VLAN
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Vlan

Return type:

Response

Example:

Click here to see an example of how to use create_vlan API.

delete_byoip_range(byoip_range_id, **kwargs)

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.

Parameters:
  • byoip_range_id (str) –

    (required) The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_byoip_range API.

delete_cpe(cpe_id, **kwargs)

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.

Parameters:
  • cpe_id (str) –

    (required) The OCID of the CPE.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_cpe API.

delete_cross_connect(cross_connect_id, **kwargs)

Deletes the specified cross-connect. It must not be mapped to a VirtualCircuit.

Parameters:
  • cross_connect_id (str) –

    (required) The OCID of the cross-connect.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_cross_connect API.

delete_cross_connect_group(cross_connect_group_id, **kwargs)

Deletes the specified cross-connect group. It must not contain any cross-connects, and it cannot be mapped to a VirtualCircuit.

Parameters:
  • cross_connect_group_id (str) –

    (required) The OCID of the cross-connect group.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_cross_connect_group API.

delete_dhcp_options(dhcp_id, **kwargs)

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.

Parameters:
  • dhcp_id (str) –

    (required) The OCID for the set of DHCP options.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_dhcp_options API.

delete_drg(drg_id, **kwargs)

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.

Parameters:
  • drg_id (str) –

    (required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_drg API.

delete_drg_attachment(drg_attachment_id, **kwargs)

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.

Parameters:
  • drg_attachment_id (str) –

    (required) The OCID of the DRG attachment.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_drg_attachment API.

delete_drg_route_distribution(drg_route_distribution_id, **kwargs)

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.

Parameters:
  • drg_route_distribution_id (str) –

    (required) The OCID of the route distribution.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_drg_route_distribution API.

delete_drg_route_table(drg_route_table_id, **kwargs)

Deletes the specified DRG route table. There must not be any DRG attachments assigned.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_drg_route_table API.

delete_internet_gateway(ig_id, **kwargs)

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.

Parameters:
  • ig_id (str) –

    (required) The OCID of the internet gateway.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_internet_gateway API.

delete_ip_sec_connection(ipsc_id, **kwargs)

Deletes the specified IPSec connection. If your goal is to disable the IPSec VPN between your VCN and on-premises network, it’s easiest to simply detach the DRG but keep all the IPSec VPN components intact. If you were to delete all the components and then later need to create an IPSec 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.

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_ip_sec_connection API.

delete_ipv6(ipv6_id, **kwargs)

Unassigns and deletes the specified IPv6. You must specify the object’s OCID. The IPv6 address is returned to the subnet’s pool of available addresses.

Parameters:
  • ipv6_id (str) –

    (required) The OCID of the IPv6.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_ipv6 API.

delete_local_peering_gateway(local_peering_gateway_id, **kwargs)

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.

Parameters:
  • local_peering_gateway_id (str) –

    (required) The OCID of the local peering gateway.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_local_peering_gateway API.

delete_nat_gateway(nat_gateway_id, **kwargs)

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.

Parameters:
  • nat_gateway_id (str) –

    (required) The NAT gateway’s OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_nat_gateway API.

delete_network_security_group(network_security_group_id, **kwargs)

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(). 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).

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_network_security_group API.

delete_private_ip(private_ip_id, **kwargs)

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.

Parameters:
  • private_ip_id (str) –

    (required) The OCID of the private IP.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_private_ip API.

delete_public_ip(public_ip_id, **kwargs)

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().

Parameters:
  • public_ip_id (str) –

    (required) The OCID of the public IP.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_public_ip API.

delete_public_ip_pool(public_ip_pool_id, **kwargs)

Deletes the specified public IP pool. To delete a public IP pool it must not have any active IP address allocations. You must specify the object’s OCID when deleting an IP pool.

Parameters:
  • public_ip_pool_id (str) –

    (required) The OCID of the public IP pool.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_public_ip_pool API.

delete_remote_peering_connection(remote_peering_connection_id, **kwargs)

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.

Parameters:
  • remote_peering_connection_id (str) –

    (required) The OCID of the remote peering connection (RPC).

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_remote_peering_connection API.

delete_route_table(rt_id, **kwargs)

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.

Parameters:
  • rt_id (str) –

    (required) The OCID of the route table.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_route_table API.

delete_security_list(security_list_id, **kwargs)

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.

Parameters:
  • security_list_id (str) –

    (required) The OCID of the security list.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_security_list API.

delete_service_gateway(service_gateway_id, **kwargs)

Deletes the specified service gateway. There must not be a route table that lists the service gateway as a target.

Parameters:
  • service_gateway_id (str) –

    (required) The service gateway’s OCID.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_service_gateway API.

delete_subnet(subnet_id, **kwargs)

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.

Parameters:
  • subnet_id (str) –

    (required) The OCID of the subnet.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_subnet API.

delete_vcn(vcn_id, **kwargs)

Deletes the specified VCN. The VCN must be empty and have no attached gateways. This is an asynchronous operation. The VCN’s lifecycleState will change to TERMINATING temporarily until the VCN is completely removed.

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_vcn API.

delete_virtual_circuit(virtual_circuit_id, **kwargs)

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.

Parameters:
  • virtual_circuit_id (str) –

    (required) The OCID of the virtual circuit.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_virtual_circuit API.

delete_vlan(vlan_id, **kwargs)

Deletes the specified VLAN, but only if there are no VNICs in the VLAN.

Parameters:
  • vlan_id (str) –

    (required) The OCID of the VLAN.

  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use delete_vlan API.

detach_service_id(service_gateway_id, detach_service_details, **kwargs)

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.

Parameters:
  • service_gateway_id (str) –

    (required) The service gateway’s OCID.

  • detach_service_details (oci.core.models.ServiceIdRequestDetails) – (required) ServiceId of Service to be detached from a service gateway.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceGateway

Return type:

Response

Example:

Click here to see an example of how to use detach_service_id API.

get_all_drg_attachments(drg_id, **kwargs)

Returns a complete list of DRG attachments that belong to a particular DRG.

Parameters:
  • drg_id (str) –

    (required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • attachment_type (str) –

    (optional) The type for the network resource attached to the DRG.

    Allowed values are: “VCN”, “VIRTUAL_CIRCUIT”, “REMOTE_PEERING_CONNECTION”, “IPSEC_TUNNEL”, “ALL”

  • is_cross_tenancy (bool) – (optional) Whether the DRG attachment lives in a different tenancy than the DRG.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgAttachmentInfo

Return type:

Response

Example:

Click here to see an example of how to use get_all_drg_attachments API.

get_byoip_range(byoip_range_id, **kwargs)

Gets the ByoipRange resource. You must specify the OCID.

Parameters:
  • byoip_range_id (str) –

    (required) The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ByoipRange

Return type:

Response

Example:

Click here to see an example of how to use get_byoip_range API.

get_cpe(cpe_id, **kwargs)

Gets the specified CPE’s information.

Parameters:
  • cpe_id (str) –

    (required) The OCID of the CPE.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Cpe

Return type:

Response

Example:

Click here to see an example of how to use get_cpe API.

get_cpe_device_config_content(cpe_id, **kwargs)

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:

returns CPE configuration content for all tunnels in a single IPSec connection. * get_tunnel_cpe_device_config_content() returns CPE configuration content for a specific tunnel within an IPSec connection.

Parameters:
  • cpe_id (str) –

    (required) The OCID of the CPE.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use get_cpe_device_config_content API.

get_cpe_device_shape(cpe_device_shape_id, **kwargs)

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:

Parameters:
  • cpe_device_shape_id (str) –

    (required) The OCID of the CPE device shape.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CpeDeviceShapeDetail

Return type:

Response

Example:

Click here to see an example of how to use get_cpe_device_shape API.

get_cross_connect(cross_connect_id, **kwargs)

Gets the specified cross-connect’s information.

Parameters:
  • cross_connect_id (str) –

    (required) The OCID of the cross-connect.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnect

Return type:

Response

Example:

Click here to see an example of how to use get_cross_connect API.

get_cross_connect_group(cross_connect_group_id, **kwargs)

Gets the specified cross-connect group’s information.

Parameters:
  • cross_connect_group_id (str) –

    (required) The OCID of the cross-connect group.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnectGroup

Return type:

Response

Example:

Click here to see an example of how to use get_cross_connect_group API.

get_cross_connect_letter_of_authority(cross_connect_id, **kwargs)

Gets the Letter of Authority for the specified cross-connect.

Parameters:
  • cross_connect_id (str) –

    (required) The OCID of the cross-connect.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LetterOfAuthority

Return type:

Response

Example:

Click here to see an example of how to use get_cross_connect_letter_of_authority API.

get_cross_connect_status(cross_connect_id, **kwargs)

Gets the status of the specified cross-connect.

Parameters:
  • cross_connect_id (str) –

    (required) The OCID of the cross-connect.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnectStatus

Return type:

Response

Example:

Click here to see an example of how to use get_cross_connect_status API.

get_dhcp_options(dhcp_id, **kwargs)

Gets the specified set of DHCP options.

Parameters:
  • dhcp_id (str) –

    (required) The OCID for the set of DHCP options.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DhcpOptions

Return type:

Response

Example:

Click here to see an example of how to use get_dhcp_options API.

get_drg(drg_id, **kwargs)

Gets the specified DRG’s information.

Parameters:
  • drg_id (str) –

    (required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Drg

Return type:

Response

Example:

Click here to see an example of how to use get_drg API.

get_drg_attachment(drg_attachment_id, **kwargs)

Gets the DrgAttachment resource.

Parameters:
  • drg_attachment_id (str) –

    (required) The OCID of the DRG attachment.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgAttachment

Return type:

Response

Example:

Click here to see an example of how to use get_drg_attachment API.

get_drg_redundancy_status(drg_id, **kwargs)

Gets the redundancy status for the specified DRG. For more information, see Redundancy Remedies.

Parameters:
  • drg_id (str) –

    (required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRedundancyStatus

Return type:

Response

Example:

Click here to see an example of how to use get_drg_redundancy_status API.

get_drg_route_distribution(drg_route_distribution_id, **kwargs)

Gets the specified route distribution’s information.

Parameters:
  • drg_route_distribution_id (str) –

    (required) The OCID of the route distribution.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRouteDistribution

Return type:

Response

Example:

Click here to see an example of how to use get_drg_route_distribution API.

get_drg_route_table(drg_route_table_id, **kwargs)

Gets the specified DRG route table’s information.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRouteTable

Return type:

Response

Example:

Click here to see an example of how to use get_drg_route_table API.

get_fast_connect_provider_service(provider_service_id, **kwargs)

Gets the specified provider service. For more information, see FastConnect Overview.

Parameters:
  • provider_service_id (str) –

    (required) The OCID of the provider service.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FastConnectProviderService

Return type:

Response

Example:

Click here to see an example of how to use get_fast_connect_provider_service API.

get_fast_connect_provider_service_key(provider_service_id, provider_service_key_name, **kwargs)

Gets the specified provider service key’s information. Use this operation to validate a provider service key. An invalid key returns a 404 error.

Parameters:
  • provider_service_id (str) –

    (required) The OCID of the provider service.

  • provider_service_key_name (str) – (required) The provider service key that the provider gives you when you set up a virtual circuit connection from the provider to Oracle Cloud Infrastructure. You can set up that connection and get your provider service key at the provider’s website or portal. For the portal location, see the description attribute of the FastConnectProviderService.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type FastConnectProviderServiceKey

Return type:

Response

Example:

Click here to see an example of how to use get_fast_connect_provider_service_key API.

get_internet_gateway(ig_id, **kwargs)

Gets the specified internet gateway’s information.

Parameters:
  • ig_id (str) –

    (required) The OCID of the internet gateway.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InternetGateway

Return type:

Response

Example:

Click here to see an example of how to use get_internet_gateway API.

get_ip_sec_connection(ipsc_id, **kwargs)

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().

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnection

Return type:

Response

Example:

Click here to see an example of how to use get_ip_sec_connection API.

get_ip_sec_connection_device_config(ipsc_id, **kwargs)

Deprecated. To get tunnel information, instead use:

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnectionDeviceConfig

Return type:

Response

Example:

Click here to see an example of how to use get_ip_sec_connection_device_config API.

get_ip_sec_connection_device_status(ipsc_id, **kwargs)

Deprecated. To get the tunnel status, instead use get_ip_sec_connection_tunnel().

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnectionDeviceStatus

Return type:

Response

Example:

Click here to see an example of how to use get_ip_sec_connection_device_status API.

get_ip_sec_connection_tunnel(ipsc_id, tunnel_id, **kwargs)

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().

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • tunnel_id (str) –

    (required) The OCID of the tunnel.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnectionTunnel

Return type:

Response

Example:

Click here to see an example of how to use get_ip_sec_connection_tunnel API.

get_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, **kwargs)

Gets the specified tunnel’s shared secret (pre-shared key). To get other information about the tunnel, use get_ip_sec_connection_tunnel().

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • tunnel_id (str) –

    (required) The OCID of the tunnel.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnectionTunnelSharedSecret

Return type:

Response

Example:

Click here to see an example of how to use get_ip_sec_connection_tunnel_shared_secret API.

get_ipsec_cpe_device_config_content(ipsc_id, **kwargs)

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:

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.

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use get_ipsec_cpe_device_config_content API.

get_ipv6(ipv6_id, **kwargs)

Gets the specified IPv6. You must specify the object’s OCID. Alternatively, you can get the object by using list_ipv6s() with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet OCID.

Parameters:
  • ipv6_id (str) –

    (required) The OCID of the IPv6.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Ipv6

Return type:

Response

Example:

Click here to see an example of how to use get_ipv6 API.

get_local_peering_gateway(local_peering_gateway_id, **kwargs)

Gets the specified local peering gateway’s information.

Parameters:
  • local_peering_gateway_id (str) –

    (required) The OCID of the local peering gateway.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LocalPeeringGateway

Return type:

Response

Example:

Click here to see an example of how to use get_local_peering_gateway API.

get_nat_gateway(nat_gateway_id, **kwargs)

Gets the specified NAT gateway’s information.

Parameters:
  • nat_gateway_id (str) –

    (required) The NAT gateway’s OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NatGateway

Return type:

Response

Example:

Click here to see an example of how to use get_nat_gateway API.

get_network_security_group(network_security_group_id, **kwargs)

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().

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NetworkSecurityGroup

Return type:

Response

Example:

Click here to see an example of how to use get_network_security_group API.

get_networking_topology(compartment_id, **kwargs)

Gets a virtual networking topology for the current region.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • access_level (str) –

    (optional) Valid values are ANY and ACCESSIBLE. The default is ANY. Setting this to ACCESSIBLE returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions.

    When set to ANY permissions are not checked.

    Allowed values are: “ANY”, “ACCESSIBLE”

  • query_compartment_subtree (bool) – (optional) When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel. Default is false.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_none_match (str) – (optional) For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn’t have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource’s ETag doesn’t match any of the values listed.
  • cache_control (str) – (optional) The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NetworkingTopology

Return type:

Response

Example:

Click here to see an example of how to use get_networking_topology API.

get_private_ip(private_ip_id, **kwargs)

Gets the specified private IP. You must specify the object’s OCID. Alternatively, you can get the object by using list_private_ips() with the private IP address (for example, 10.0.3.3) and subnet OCID.

Parameters:
  • private_ip_id (str) –

    (required) The OCID of the private IP.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PrivateIp

Return type:

Response

Example:

Click here to see an example of how to use get_private_ip API.

get_public_ip(public_ip_id, **kwargs)

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() 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.

Parameters:
  • public_ip_id (str) –

    (required) The OCID of the public IP.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIp

Return type:

Response

Example:

Click here to see an example of how to use get_public_ip API.

get_public_ip_by_ip_address(get_public_ip_by_ip_address_details, **kwargs)

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.

Parameters:
  • get_public_ip_by_ip_address_details (oci.core.models.GetPublicIpByIpAddressDetails) – (required) IP address details for fetching the public IP.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIp

Return type:

Response

Example:

Click here to see an example of how to use get_public_ip_by_ip_address API.

get_public_ip_by_private_ip_id(get_public_ip_by_private_ip_id_details, **kwargs)

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() 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.

Parameters:
  • get_public_ip_by_private_ip_id_details (oci.core.models.GetPublicIpByPrivateIpIdDetails) – (required) Private IP details for fetching the public IP.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIp

Return type:

Response

Example:

Click here to see an example of how to use get_public_ip_by_private_ip_id API.

get_public_ip_pool(public_ip_pool_id, **kwargs)

Gets the specified PublicIpPool object. You must specify the object’s OCID.

Parameters:
  • public_ip_pool_id (str) –

    (required) The OCID of the public IP pool.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIpPool

Return type:

Response

Example:

Click here to see an example of how to use get_public_ip_pool API.

get_remote_peering_connection(remote_peering_connection_id, **kwargs)

Get the specified remote peering connection’s information.

Parameters:
  • remote_peering_connection_id (str) –

    (required) The OCID of the remote peering connection (RPC).

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RemotePeeringConnection

Return type:

Response

Example:

Click here to see an example of how to use get_remote_peering_connection API.

get_route_table(rt_id, **kwargs)

Gets the specified route table’s information.

Parameters:
  • rt_id (str) –

    (required) The OCID of the route table.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type RouteTable

Return type:

Response

Example:

Click here to see an example of how to use get_route_table API.

get_security_list(security_list_id, **kwargs)

Gets the specified security list’s information.

Parameters:
  • security_list_id (str) –

    (required) The OCID of the security list.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type SecurityList

Return type:

Response

Example:

Click here to see an example of how to use get_security_list API.

get_service(service_id, **kwargs)

Gets the specified Service object.

Parameters:
  • service_id (str) –

    (required) The service’s OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Service

Return type:

Response

Example:

Click here to see an example of how to use get_service API.

get_service_gateway(service_gateway_id, **kwargs)

Gets the specified service gateway’s information.

Parameters:
  • service_gateway_id (str) –

    (required) The service gateway’s OCID.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ServiceGateway

Return type:

Response

Example:

Click here to see an example of how to use get_service_gateway API.

get_subnet(subnet_id, **kwargs)

Gets the specified subnet’s information.

Parameters:
  • subnet_id (str) –

    (required) The OCID of the subnet.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Subnet

Return type:

Response

Example:

Click here to see an example of how to use get_subnet API.

get_tunnel_cpe_device_config(ipsc_id, tunnel_id, **kwargs)

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().

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • tunnel_id (str) –

    (required) The OCID of the tunnel.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type TunnelCpeDeviceConfig

Return type:

Response

Example:

Click here to see an example of how to use get_tunnel_cpe_device_config API.

get_tunnel_cpe_device_config_content(ipsc_id, tunnel_id, **kwargs)

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:

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.

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • tunnel_id (str) –

    (required) The OCID of the tunnel.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type stream

Return type:

Response

Example:

Click here to see an example of how to use get_tunnel_cpe_device_config_content API.

get_upgrade_status(drg_id, **kwargs)

Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.

Parameters:
  • drg_id (str) –

    (required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type UpgradeStatus

Return type:

Response

Example:

Click here to see an example of how to use get_upgrade_status API.

get_vcn(vcn_id, **kwargs)

Gets the specified VCN’s information.

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Vcn

Return type:

Response

Example:

Click here to see an example of how to use get_vcn API.

get_vcn_dns_resolver_association(vcn_id, **kwargs)

Get the associated DNS resolver information with a vcn

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VcnDnsResolverAssociation

Return type:

Response

Example:

Click here to see an example of how to use get_vcn_dns_resolver_association API.

get_vcn_topology(compartment_id, vcn_id, **kwargs)

Gets a virtual network topology for a given VCN.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • vcn_id (str) –

    (required) The OCID of the VCN.

  • access_level (str) –

    (optional) Valid values are ANY and ACCESSIBLE. The default is ANY. Setting this to ACCESSIBLE returns only compartments for which a user has INSPECT permissions, either directly or indirectly (permissions can be on a resource in a subcompartment). A restricted set of fields is returned for compartments in which a user has indirect INSPECT permissions.

    When set to ANY permissions are not checked.

    Allowed values are: “ANY”, “ACCESSIBLE”

  • query_compartment_subtree (bool) – (optional) When set to true, the hierarchy of compartments is traversed and the specified compartment and its subcompartments are inspected depending on the the setting of accessLevel. Default is false.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_none_match (str) – (optional) For querying if there is a cached value on the server. The If-None-Match HTTP request header makes the request conditional. For GET and HEAD methods, the server will send back the requested resource, with a 200 status, only if it doesn’t have an ETag matching the given ones. For other methods, the request will be processed only if the eventually existing resource’s ETag doesn’t match any of the values listed.
  • cache_control (str) – (optional) The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VcnTopology

Return type:

Response

Example:

Click here to see an example of how to use get_vcn_topology API.

get_virtual_circuit(virtual_circuit_id, **kwargs)

Gets the specified virtual circuit’s information.

Parameters:
  • virtual_circuit_id (str) –

    (required) The OCID of the virtual circuit.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type VirtualCircuit

Return type:

Response

Example:

Click here to see an example of how to use get_virtual_circuit API.

get_vlan(vlan_id, **kwargs)

Gets the specified VLAN’s information.

Parameters:
  • vlan_id (str) –

    (required) The OCID of the VLAN.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Vlan

Return type:

Response

Example:

Click here to see an example of how to use get_vlan API.

get_vnic(vnic_id, **kwargs)

Gets the information for the specified virtual network interface card (VNIC). You can get the VNIC OCID from the list_vnic_attachments() operation.

Parameters:
  • vnic_id (str) –

    (required) The OCID of the VNIC.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Vnic

Return type:

Response

Example:

Click here to see an example of how to use get_vnic API.

list_allowed_peer_regions_for_remote_peering(**kwargs)

Lists the regions that support remote VCN peering (which is peering across regions). For more information, see VCN Peering.

Parameters:retry_strategy (obj) –

(optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:A Response object with data of type list of PeerRegionForRemotePeering
Return type:Response
Example:

Click here to see an example of how to use list_allowed_peer_regions_for_remote_peering API.

list_byoip_allocated_ranges(byoip_range_id, **kwargs)

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.

Parameters:
  • byoip_range_id (str) –

    (required) The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ByoipAllocatedRangeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_byoip_allocated_ranges API.

list_byoip_ranges(compartment_id, **kwargs)

Lists the ByoipRange resources in the specified compartment. You can filter the list using query parameters.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • lifecycle_state (str) – (optional) A filter to return only resources that match the given lifecycle state name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ByoipRangeCollection

Return type:

Response

Example:

Click here to see an example of how to use list_byoip_ranges API.

list_cpe_device_shapes(**kwargs)

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 OCID (returned by this operation).

For information about generating CPE configuration content, see these operations:

Parameters:
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CpeDeviceShapeSummary

Return type:

Response

Example:

Click here to see an example of how to use list_cpe_device_shapes API.

list_cpes(compartment_id, **kwargs)

Lists the customer-premises equipment objects (CPEs) in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Cpe

Return type:

Response

Example:

Click here to see an example of how to use list_cpes API.

list_cross_connect_groups(compartment_id, **kwargs)

Lists the cross-connect groups in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

    Allowed values are: “PROVISIONING”, “PROVISIONED”, “INACTIVE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CrossConnectGroup

Return type:

Response

Example:

Click here to see an example of how to use list_cross_connect_groups API.

list_cross_connect_locations(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CrossConnectLocation

Return type:

Response

Example:

Click here to see an example of how to use list_cross_connect_locations API.

list_cross_connect_mappings(virtual_circuit_id, **kwargs)

Lists the Cross Connect mapping Details for the specified virtual circuit.

Parameters:
  • virtual_circuit_id (str) –

    (required) The OCID of the virtual circuit.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnectMappingDetailsCollection

Return type:

Response

Example:

Click here to see an example of how to use list_cross_connect_mappings API.

list_cross_connects(compartment_id, **kwargs)

Lists the cross-connects in the specified compartment. You can filter the list by specifying the OCID of a cross-connect group.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • cross_connect_group_id (str) –

    (optional) The OCID of the cross-connect group.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

    Allowed values are: “PENDING_CUSTOMER”, “PROVISIONING”, “PROVISIONED”, “INACTIVE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CrossConnect

Return type:

Response

Example:

Click here to see an example of how to use list_cross_connects API.

list_crossconnect_port_speed_shapes(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of CrossConnectPortSpeedShape

Return type:

Response

Example:

Click here to see an example of how to use list_crossconnect_port_speed_shapes API.

list_dhcp_options(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DhcpOptions

Return type:

Response

Example:

Click here to see an example of how to use list_dhcp_options API.

list_drg_attachments(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • drg_id (str) –

    (optional) The OCID of the DRG.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • network_id (str) –

    (optional) The OCID of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG.

  • attachment_type (str) –

    (optional) The type for the network resource attached to the DRG.

    Allowed values are: “VCN”, “VIRTUAL_CIRCUIT”, “REMOTE_PEERING_CONNECTION”, “IPSEC_TUNNEL”, “ALL”

  • drg_route_table_id (str) –

    (optional) The OCID of the DRG route table assigned to the DRG attachment.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

    Allowed values are: “ATTACHING”, “ATTACHED”, “DETACHING”, “DETACHED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgAttachment

Return type:

Response

Example:

Click here to see an example of how to use list_drg_attachments API.

list_drg_route_distribution_statements(drg_route_distribution_id, **kwargs)

Lists the statements for the specified route distribution.

Parameters:
  • drg_route_distribution_id (str) –

    (required) The OCID of the route distribution.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • sort_by (str) –

    (optional) The field to sort by.

    Allowed values are: “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteDistributionStatement

Return type:

Response

Example:

Click here to see an example of how to use list_drg_route_distribution_statements API.

list_drg_route_distributions(drg_id, **kwargs)

Lists the route distributions in the specified DRG.

To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation.

Parameters:
  • drg_id (str) –

    (required) The OCID of the DRG.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter that only returns resources that match the specified lifecycle state. The value is case insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteDistribution

Return type:

Response

Example:

Click here to see an example of how to use list_drg_route_distributions API.

list_drg_route_rules(drg_route_table_id, **kwargs)

Lists the route rules in the specified DRG route table.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • route_type (str) –

    (optional) Static routes are specified through the DRG route table API. Dynamic routes are learned by the DRG from the DRG attachments through various routing protocols.

    Allowed values are: “STATIC”, “DYNAMIC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteRule

Return type:

Response

Example:

Click here to see an example of how to use list_drg_route_rules API.

list_drg_route_tables(drg_id, **kwargs)

Lists the DRG route tables for the specified DRG.

Use the ListDrgRouteRules operation to retrieve the route rules in a table.

Parameters:
  • drg_id (str) –

    (required) The OCID of the DRG.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • import_drg_route_distribution_id (str) –

    (optional) The OCID of the import route distribution.

  • lifecycle_state (str) –

    (optional) A filter that only returns matches for the specified lifecycle state. The value is case insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteTable

Return type:

Response

Example:

Click here to see an example of how to use list_drg_route_tables API.

list_drgs(compartment_id, **kwargs)

Lists the DRGs in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Drg

Return type:

Response

Example:

Click here to see an example of how to use list_drgs API.

list_fast_connect_provider_services(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of FastConnectProviderService

Return type:

Response

Example:

Click here to see an example of how to use list_fast_connect_provider_services API.

list_fast_connect_provider_virtual_circuit_bandwidth_shapes(provider_service_id, **kwargs)

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.

Parameters:
  • provider_service_id (str) –

    (required) The OCID of the provider service.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VirtualCircuitBandwidthShape

Return type:

Response

Example:

Click here to see an example of how to use list_fast_connect_provider_virtual_circuit_bandwidth_shapes API.

list_internet_gateways(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of InternetGateway

Return type:

Response

Example:

Click here to see an example of how to use list_internet_gateways API.

list_ip_sec_connection_tunnels(ipsc_id, **kwargs)

Lists the tunnel information for the specified IPSec connection.

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of IPSecConnectionTunnel

Return type:

Response

Example:

Click here to see an example of how to use list_ip_sec_connection_tunnels API.

list_ip_sec_connections(compartment_id, **kwargs)

Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • drg_id (str) –

    (optional) The OCID of the DRG.

  • cpe_id (str) –

    (optional) The OCID of the CPE.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of IPSecConnection

Return type:

Response

Example:

Click here to see an example of how to use list_ip_sec_connections API.

list_ipv6s(**kwargs)

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() requires the OCID.

Parameters:
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • ip_address (str) – (optional) An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3
  • subnet_id (str) –

    (optional) The OCID of the subnet.

  • vnic_id (str) – (optional) The OCID of the VNIC.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Ipv6

Return type:

Response

Example:

Click here to see an example of how to use list_ipv6s API.

list_local_peering_gateways(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of LocalPeeringGateway

Return type:

Response

Example:

Click here to see an example of how to use list_local_peering_gateways API.

list_nat_gateways(compartment_id, **kwargs)

Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of NatGateway

Return type:

Response

Example:

Click here to see an example of how to use list_nat_gateways API.

list_network_security_group_security_rules(network_security_group_id, **kwargs)

Lists the security rules in the specified network security group.

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • direction (str) –

    (optional) Direction of the security rule. Set to EGRESS for rules that allow outbound IP packets, or INGRESS for rules that allow inbound IP packets.

    Allowed values are: “EGRESS”, “INGRESS”

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • sort_by (str) –

    (optional) The field to sort by.

    Allowed values are: “TIMECREATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of SecurityRule

Return type:

Response

Example:

Click here to see an example of how to use list_network_security_group_security_rules API.

list_network_security_group_vnics(network_security_group_id, **kwargs)

Lists the VNICs in the specified network security group.

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • sort_by (str) –

    (optional) The field to sort by.

    Allowed values are: “TIMEASSOCIATED”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of NetworkSecurityGroupVnic

Return type:

Response

Example:

Click here to see an example of how to use list_network_security_group_vnics API.

list_network_security_groups(**kwargs)

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.

Parameters:
  • compartment_id (str) –

    (optional) The OCID of the compartment.

  • vlan_id (str) –

    (optional) The OCID of the VLAN.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of NetworkSecurityGroup

Return type:

Response

Example:

Click here to see an example of how to use list_network_security_groups API.

list_private_ips(**kwargs)

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() requires the OCID.

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.

Parameters:
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • ip_address (str) – (optional) An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: 10.0.3.3
  • subnet_id (str) –

    (optional) The OCID of the subnet.

  • vnic_id (str) – (optional) The OCID of the VNIC.
  • vlan_id (str) –

    (optional) The OCID of the VLAN.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PrivateIp

Return type:

Response

Example:

Click here to see an example of how to use list_private_ips API.

list_public_ip_pools(compartment_id, **kwargs)

Lists the public IP pools in the specified compartment. You can filter the list using query parameters.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • byoip_range_id (str) – (optional) A filter to return only resources that match the given BYOIP CIDR block.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIpPoolCollection

Return type:

Response

Example:

Click here to see an example of how to use list_public_ip_pools API.

list_public_ips(scope, compartment_id, **kwargs)

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.

Parameters:
  • scope (str) –

    (required) Whether the public IP is regional or specific to a particular availability domain.

    • REGION: The public IP exists within a region and is assigned to a regional entity

    (such as a NatGateway), or can be assigned to a private IP in any availability domain in the region. Reserved public IPs have scope = REGION, as do ephemeral public IPs assigned to a regional entity.

    • AVAILABILITY_DOMAIN: The public IP exists within the availability domain of the entity

    it’s assigned to, which is specified by the availabilityDomain property of the public IP object. Ephemeral public IPs that are assigned to private IPs have scope = AVAILABILITY_DOMAIN.

    Allowed values are: “REGION”, “AVAILABILITY_DOMAIN”

  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • availability_domain (str) –

    (optional) The name of the availability domain.

    Example: Uocm:PHX-AD-1

  • lifetime (str) –

    (optional) A filter to return only public IPs that match given lifetime.

    Allowed values are: “EPHEMERAL”, “RESERVED”

  • public_ip_pool_id (str) – (optional) A filter to return only resources that belong to the given public IP pool.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of PublicIp

Return type:

Response

Example:

Click here to see an example of how to use list_public_ips API.

list_remote_peering_connections(compartment_id, **kwargs)

Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC’s compartment).

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • drg_id (str) –

    (optional) The OCID of the DRG.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of RemotePeeringConnection

Return type:

Response

Example:

Click here to see an example of how to use list_remote_peering_connections API.

list_route_tables(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of RouteTable

Return type:

Response

Example:

Click here to see an example of how to use list_route_tables API.

list_security_lists(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of SecurityList

Return type:

Response

Example:

Click here to see an example of how to use list_security_lists API.

list_service_gateways(compartment_id, **kwargs)

Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of ServiceGateway

Return type:

Response

Example:

Click here to see an example of how to use list_service_gateways API.

list_services(**kwargs)

Lists the available Service objects that you can enable for a service gateway in this region.

Parameters:
  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Service

Return type:

Response

Example:

Click here to see an example of how to use list_services API.

list_subnets(compartment_id, **kwargs)

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.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Subnet

Return type:

Response

Example:

Click here to see an example of how to use list_subnets API.

list_vcns(compartment_id, **kwargs)

Lists the virtual cloud networks (VCNs) in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Vcn

Return type:

Response

Example:

Click here to see an example of how to use list_vcns API.

list_virtual_circuit_bandwidth_shapes(compartment_id, **kwargs)

The deprecated operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the OCID of your tenancy (the root compartment).

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VirtualCircuitBandwidthShape

Return type:

Response

Example:

Click here to see an example of how to use list_virtual_circuit_bandwidth_shapes API.

list_virtual_circuit_public_prefixes(virtual_circuit_id, **kwargs)

Lists the public IP prefixes and their details for the specified public virtual circuit.

Parameters:
  • virtual_circuit_id (str) –

    (required) The OCID of the virtual circuit.

  • verification_state (str) –

    (optional) A filter to only return resources that match the given verification state.

    The state value is case-insensitive.

    Allowed values are: “IN_PROGRESS”, “COMPLETED”, “FAILED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VirtualCircuitPublicPrefix

Return type:

Response

Example:

Click here to see an example of how to use list_virtual_circuit_public_prefixes API.

list_virtual_circuits(compartment_id, **kwargs)

Lists the virtual circuits in the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • lifecycle_state (str) –

    (optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

    Allowed values are: “PENDING_PROVIDER”, “VERIFYING”, “PROVISIONING”, “PROVISIONED”, “FAILED”, “INACTIVE”, “TERMINATING”, “TERMINATED”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of VirtualCircuit

Return type:

Response

Example:

Click here to see an example of how to use list_virtual_circuits API.

list_vlans(compartment_id, **kwargs)

Lists the VLANs in the specified VCN and the specified compartment.

Parameters:
  • compartment_id (str) –

    (required) The OCID of the compartment.

  • limit (int) –

    (optional) For list pagination. The maximum number of results per page, or items to return in a paginated “List” call. For important details about how pagination works, see List Pagination.

    Example: 50

  • page (str) –

    (optional) For list pagination. The value of the opc-next-page response header from the previous “List” call. For important details about how pagination works, see List Pagination.

  • vcn_id (str) –

    (optional) The OCID of the VCN.

  • display_name (str) – (optional) A filter to return only resources that match the given display name exactly.
  • sort_by (str) –

    (optional) The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.

    Note: In general, some “List” operations (for example, ListInstances) let you optionally filter by availability domain if the scope of the resource type is within a single availability domain. If you call one of these “List” operations without specifying an availability domain, the resources are grouped by availability domain, then sorted.

    Allowed values are: “TIMECREATED”, “DISPLAYNAME”

  • sort_order (str) –

    (optional) The sort order to use, either ascending (ASC) or descending (DESC). The DISPLAYNAME sort order is case sensitive.

    Allowed values are: “ASC”, “DESC”

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • lifecycle_state (str) –

    (optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.

    Allowed values are: “PROVISIONING”, “AVAILABLE”, “TERMINATING”, “TERMINATED”, “UPDATING”

  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of Vlan

Return type:

Response

Example:

Click here to see an example of how to use list_vlans API.

modify_vcn_cidr(vcn_id, modify_vcn_cidr_details, **kwargs)

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.

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • modify_vcn_cidr_details (oci.core.models.ModifyVcnCidrDetails) – (required) Details object for updating a VCN CIDR.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use modify_vcn_cidr API.

remove_drg_route_distribution_statements(drg_route_distribution_id, remove_drg_route_distribution_statements_details, **kwargs)

Removes one or more route distribution statements from the specified route distribution’s map.

Parameters:
  • drg_route_distribution_id (str) –

    (required) The OCID of the route distribution.

  • remove_drg_route_distribution_statements_details (oci.core.models.RemoveDrgRouteDistributionStatementsDetails) – (required) Request with one or more route distribution statements to remove from the route distribution.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_drg_route_distribution_statements API.

remove_drg_route_rules(drg_route_table_id, remove_drg_route_rules_details, **kwargs)

Removes one or more route rules from the specified DRG route table.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • remove_drg_route_rules_details (oci.core.models.RemoveDrgRouteRulesDetails) – (required) Request to remove one or more route rules in the DRG route table.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_drg_route_rules API.

remove_export_drg_route_distribution(drg_attachment_id, **kwargs)

Removes the export route distribution from the DRG attachment so no routes are advertised to it.

Parameters:
  • drg_attachment_id (str) –

    (required) The OCID of the DRG attachment.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgAttachment

Return type:

Response

Example:

Click here to see an example of how to use remove_export_drg_route_distribution API.

remove_import_drg_route_distribution(drg_route_table_id, **kwargs)

Removes the import route distribution from the DRG route table so no routes are imported into it.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRouteTable

Return type:

Response

Example:

Click here to see an example of how to use remove_import_drg_route_distribution API.

remove_network_security_group_security_rules(network_security_group_id, remove_network_security_group_security_rules_details, **kwargs)

Removes one or more security rules from the specified network security group.

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • remove_network_security_group_security_rules_details (oci.core.models.RemoveNetworkSecurityGroupSecurityRulesDetails) – (required) Request with one or more security rules associated with the network security group that will be removed.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_network_security_group_security_rules API.

remove_public_ip_pool_capacity(public_ip_pool_id, remove_public_ip_pool_capacity_details, **kwargs)

Removes a CIDR block from the referenced public IP pool.

Parameters:
  • public_ip_pool_id (str) –

    (required) The OCID of the public IP pool.

  • remove_public_ip_pool_capacity_details (oci.core.models.RemovePublicIpPoolCapacityDetails) – (required) The CIDR block to remove from the IP pool.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type PublicIpPool

Return type:

Response

Example:

Click here to see an example of how to use remove_public_ip_pool_capacity API.

remove_vcn_cidr(vcn_id, remove_vcn_cidr_details, **kwargs)

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.

Parameters:
  • vcn_id (str) –

    (required) The OCID of the VCN.

  • remove_vcn_cidr_details (oci.core.models.RemoveVcnCidrDetails) – (required) Details object for removing a VCN CIDR.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • opc_retry_token (str) – (optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type None

Return type:

Response

Example:

Click here to see an example of how to use remove_vcn_cidr API.

update_byoip_range(byoip_range_id, update_byoip_range_details, **kwargs)

Updates the tags or display name associated to the specified BYOIP CIDR block.

Parameters:
  • byoip_range_id (str) –

    (required) The OCID of the ByoipRange resource containing the BYOIP CIDR block.

  • update_byoip_range_details (oci.core.models.UpdateByoipRangeDetails) – (required) Byoip Range details.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type ByoipRange

Return type:

Response

Example:

Click here to see an example of how to use update_byoip_range API.

update_cpe(cpe_id, update_cpe_details, **kwargs)

Updates the specified CPE’s display name or tags. Avoid entering confidential information.

Parameters:
  • cpe_id (str) –

    (required) The OCID of the CPE.

  • update_cpe_details (oci.core.models.UpdateCpeDetails) – (required) Details object for updating a CPE.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Cpe

Return type:

Response

Example:

Click here to see an example of how to use update_cpe API.

update_cross_connect(cross_connect_id, update_cross_connect_details, **kwargs)

Updates the specified cross-connect.

Parameters:
  • cross_connect_id (str) –

    (required) The OCID of the cross-connect.

  • update_cross_connect_details (oci.core.models.UpdateCrossConnectDetails) – (required) Update CrossConnect fields.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnect

Return type:

Response

Example:

Click here to see an example of how to use update_cross_connect API.

update_cross_connect_group(cross_connect_group_id, update_cross_connect_group_details, **kwargs)

Updates the specified cross-connect group’s display name. Avoid entering confidential information.

Parameters:
  • cross_connect_group_id (str) –

    (required) The OCID of the cross-connect group.

  • update_cross_connect_group_details (oci.core.models.UpdateCrossConnectGroupDetails) – (required) Update CrossConnectGroup fields
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type CrossConnectGroup

Return type:

Response

Example:

Click here to see an example of how to use update_cross_connect_group API.

update_dhcp_options(dhcp_id, update_dhcp_details, **kwargs)

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.

Parameters:
  • dhcp_id (str) –

    (required) The OCID for the set of DHCP options.

  • update_dhcp_details (oci.core.models.UpdateDhcpDetails) – (required) Request object for updating a set of DHCP options.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DhcpOptions

Return type:

Response

Example:

Click here to see an example of how to use update_dhcp_options API.

update_drg(drg_id, update_drg_details, **kwargs)

Updates the specified DRG’s display name or tags. Avoid entering confidential information.

Parameters:
  • drg_id (str) –

    (required) The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the DRG.

  • update_drg_details (oci.core.models.UpdateDrgDetails) – (required) Details object for updating a DRG.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Drg

Return type:

Response

Example:

Click here to see an example of how to use update_drg API.

update_drg_attachment(drg_attachment_id, update_drg_attachment_details, **kwargs)

Updates the display name and routing information for the specified DrgAttachment. Avoid entering confidential information.

Parameters:
  • drg_attachment_id (str) –

    (required) The OCID of the DRG attachment.

  • update_drg_attachment_details (oci.core.models.UpdateDrgAttachmentDetails) – (required) Details object for updating a DrgAttachment.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgAttachment

Return type:

Response

Example:

Click here to see an example of how to use update_drg_attachment API.

update_drg_route_distribution(drg_route_distribution_id, update_drg_route_distribution_details, **kwargs)

Updates the specified route distribution

Parameters:
  • drg_route_distribution_id (str) –

    (required) The OCID of the route distribution.

  • update_drg_route_distribution_details (oci.core.models.UpdateDrgRouteDistributionDetails) – (required) Details object for updating a route distribution
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRouteDistribution

Return type:

Response

Example:

Click here to see an example of how to use update_drg_route_distribution API.

update_drg_route_distribution_statements(drg_route_distribution_id, update_drg_route_distribution_statements_details, **kwargs)

Updates one or more route distribution statements in the specified route distribution.

Parameters:
  • drg_route_distribution_id (str) –

    (required) The OCID of the route distribution.

  • update_drg_route_distribution_statements_details (oci.core.models.UpdateDrgRouteDistributionStatementsDetails) – (required) Request to update one or more route distribution statements in the route distribution.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteDistributionStatement

Return type:

Response

Example:

Click here to see an example of how to use update_drg_route_distribution_statements API.

update_drg_route_rules(drg_route_table_id, update_drg_route_rules_details, **kwargs)

Updates one or more route rules in the specified DRG route table.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • update_drg_route_rules_details (oci.core.models.UpdateDrgRouteRulesDetails) – (required) Request to update one or more route rules in the DRG route table.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type list of DrgRouteRule

Return type:

Response

Example:

Click here to see an example of how to use update_drg_route_rules API.

update_drg_route_table(drg_route_table_id, update_drg_route_table_details, **kwargs)

Updates the specified DRG route table.

Parameters:
  • drg_route_table_id (str) –

    (required) The OCID of the DRG route table.

  • update_drg_route_table_details (oci.core.models.UpdateDrgRouteTableDetails) – (required) Details object used to updating a DRG route table.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type DrgRouteTable

Return type:

Response

Example:

Click here to see an example of how to use update_drg_route_table API.

update_internet_gateway(ig_id, update_internet_gateway_details, **kwargs)

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.

Parameters:
  • ig_id (str) –

    (required) The OCID of the internet gateway.

  • update_internet_gateway_details (oci.core.models.UpdateInternetGatewayDetails) – (required) Details for updating the internet gateway.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type InternetGateway

Return type:

Response

Example:

Click here to see an example of how to use update_internet_gateway API.

update_ip_sec_connection(ipsc_id, update_ip_sec_connection_details, **kwargs)

Updates the specified IPSec connection.

To update an individual IPSec tunnel’s attributes, use update_ip_sec_connection_tunnel().

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • update_ip_sec_connection_details (oci.core.models.UpdateIPSecConnectionDetails) – (required) Details object for updating a IPSec connection.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnection

Return type:

Response

Example:

Click here to see an example of how to use update_ip_sec_connection API.

update_ip_sec_connection_tunnel(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_details, **kwargs)

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 from STATIC to BGP, make sure the tunnel’s BGP session configuration attributes have been set (bgp_session_info()).
  • If you want to switch the tunnel’s routing from BGP to STATIC, make sure the IPSecConnection already has at least one valid CIDR static route.
Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • tunnel_id (str) –

    (required) The OCID of the tunnel.

  • update_ip_sec_connection_tunnel_details (oci.core.models.UpdateIPSecConnectionTunnelDetails) – (required) Details object for updating a IPSecConnection tunnel’s details.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnectionTunnel

Return type:

Response

Example:

Click here to see an example of how to use update_ip_sec_connection_tunnel API.

update_ip_sec_connection_tunnel_shared_secret(ipsc_id, tunnel_id, update_ip_sec_connection_tunnel_shared_secret_details, **kwargs)

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.

Parameters:
  • ipsc_id (str) –

    (required) The OCID of the IPSec connection.

  • tunnel_id (str) –

    (required) The OCID of the tunnel.

  • update_ip_sec_connection_tunnel_shared_secret_details (oci.core.models.UpdateIPSecConnectionTunnelSharedSecretDetails) – (required) Details object for updating a IPSec connection tunnel’s sharedSecret.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type IPSecConnectionTunnelSharedSecret

Return type:

Response

Example:

Click here to see an example of how to use update_ip_sec_connection_tunnel_shared_secret API.

update_ipv6(ipv6_id, update_ipv6_details, **kwargs)

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.
Parameters:
  • ipv6_id (str) –

    (required) The OCID of the IPv6.

  • update_ipv6_details (oci.core.models.UpdateIpv6Details) – (required) IPv6 details to be updated.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • opc_request_id (str) – (optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type Ipv6

Return type:

Response

Example:

Click here to see an example of how to use update_ipv6 API.

update_local_peering_gateway(local_peering_gateway_id, update_local_peering_gateway_details, **kwargs)

Updates the specified local peering gateway (LPG).

Parameters:
  • local_peering_gateway_id (str) –

    (required) The OCID of the local peering gateway.

  • update_local_peering_gateway_details (oci.core.models.UpdateLocalPeeringGatewayDetails) – (required) Details object for updating a local peering gateway.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type LocalPeeringGateway

Return type:

Response

Example:

Click here to see an example of how to use update_local_peering_gateway API.

update_nat_gateway(nat_gateway_id, update_nat_gateway_details, **kwargs)

Updates the specified NAT gateway.

Parameters:
  • nat_gateway_id (str) –

    (required) The NAT gateway’s OCID.

  • update_nat_gateway_details (oci.core.models.UpdateNatGatewayDetails) – (required) Details object for updating a NAT gateway.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NatGateway

Return type:

Response

Example:

Click here to see an example of how to use update_nat_gateway API.

update_network_security_group(network_security_group_id, update_network_security_group_details, **kwargs)

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().

Parameters:
  • network_security_group_id (str) –

    (required) The OCID of the network security group.

  • update_network_security_group_details (oci.core.models.UpdateNetworkSecurityGroupDetails) – (required) Details object for updating a network security group.
  • if_match (str) – (optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource’s current etag value.
  • retry_strategy (obj) –

    (optional) A retry strategy to apply to this specific operation/call. This will override any retry strategy set at the client-level.

    This should be one of the strategies available in the retry module. A convenience DEFAULT_RETRY_STRATEGY is also available. The specifics of the default retry strategy are described here.

    To have this operation explicitly not perform any retries, pass an instance of NoneRetryStrategy.

Returns:

A Response object with data of type NetworkSecurityGroup

Return type:

Response

Example:

Click here to see