Core Virtual Network Functions

ADD_DRG_ROUTE_DISTRIBUTION_STATEMENTS Function

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

Syntax

FUNCTION add_drg_route_distribution_statements (
  drg_route_distribution_id varchar2,
  add_drg_route_distribution_statements_details dbms_cloud_oci_core_add_drg_route_distribution_statements_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_add_drg_route_distribution_statements_response_t;

Parameters

Parameter	Description
`drg_route_distribution_id`	(required) The OCID of the route distribution.
`add_drg_route_distribution_statements_details`	(required) Request with one or more route distribution statements to be inserted into the route distribution.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_DRG_ROUTE_RULES Function

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

Syntax

FUNCTION add_drg_route_rules (
  drg_route_table_id varchar2,
  add_drg_route_rules_details dbms_cloud_oci_core_add_drg_route_rules_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_add_drg_route_rules_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`add_drg_route_rules_details`	(required) Request for one or more route rules to be inserted into the DRG route table.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_IPV6_SUBNET_CIDR Function

Add an IPv6 prefix to a subnet.

Syntax

FUNCTION add_ipv6_subnet_cidr (
  subnet_id varchar2,
  add_subnet_ipv6_cidr_details dbms_cloud_oci_core_add_subnet_ipv6_cidr_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_add_ipv6_subnet_cidr_response_t;

Parameters

Parameter	Description
`subnet_id`	(required) The OCID of the subnet.
`add_subnet_ipv6_cidr_details`	(required) Details object for adding an IPv6 prefix to a subnet.
`opc_retry_token`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_IPV6_VCN_CIDR Function

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

Syntax

FUNCTION add_ipv6_vcn_cidr (
  vcn_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  add_vcn_ipv6_cidr_details dbms_cloud_oci_core_add_vcn_ipv6_cidr_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_add_ipv6_vcn_cidr_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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`	(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.
`add_vcn_ipv6_cidr_details`	(optional) Details object for adding an IPv6 VCN CIDR.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_NETWORK_SECURITY_GROUP_SECURITY_RULES Function

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

Syntax

FUNCTION add_network_security_group_security_rules (
  network_security_group_id varchar2,
  add_network_security_group_security_rules_details dbms_cloud_oci_core_add_network_security_group_security_rules_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_add_network_security_group_security_rules_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`add_network_security_group_security_rules_details`	(required) Request with one or more security rules to be associated with the network security group.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_PUBLIC_IP_POOL_CAPACITY Function

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.

Syntax

FUNCTION add_public_ip_pool_capacity (
  public_ip_pool_id varchar2,
  add_public_ip_pool_capacity_details dbms_cloud_oci_core_add_public_ip_pool_capacity_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_add_public_ip_pool_capacity_response_t;

Parameters

Parameter	Description
`public_ip_pool_id`	(required) The OCID of the public IP pool.
`add_public_ip_pool_capacity_details`	(required) Byoip Range prefix and a cidr from it
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADD_VCN_CIDR Function

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.

Syntax

FUNCTION add_vcn_cidr (
  vcn_id varchar2,
  add_vcn_cidr_details dbms_cloud_oci_core_add_vcn_cidr_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_add_vcn_cidr_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`add_vcn_cidr_details`	(required) Details object for deleting a VCN CIDR.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ADVERTISE_BYOIP_RANGE Function

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.

Syntax

FUNCTION advertise_byoip_range (
  byoip_range_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_advertise_byoip_range_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

ATTACH_SERVICE_ID Function

Adds the specified SERVICE Type 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 ROUTE_TABLE Type. **Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to the service gateway. Compare it with UPDATE_SERVICE_GATEWAY Function, which replaces the entire existing list of enabled `Service` objects with the list that you provide in the `Update` call.

Syntax

FUNCTION attach_service_id (
  service_gateway_id varchar2,
  attach_service_details dbms_cloud_oci_core_service_id_request_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_attach_service_id_response_t;

Parameters

Parameter	Description
`service_gateway_id`	(required) The service gateway's OCID.
`attach_service_details`	(required) ServiceId of Service to be attached to a service gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BULK_ADD_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function

Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not UPDATE_VIRTUAL_CIRCUIT Function) 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.

Syntax

FUNCTION bulk_add_virtual_circuit_public_prefixes (
  virtual_circuit_id varchar2,
  bulk_add_virtual_circuit_public_prefixes_details dbms_cloud_oci_core_bulk_add_virtual_circuit_public_prefixes_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_bulk_add_virtual_circuit_public_prefixes_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`bulk_add_virtual_circuit_public_prefixes_details`	(required) Request with publix prefixes to be added to the virtual circuit
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

BULK_DELETE_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function

Removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not UPDATE_VIRTUAL_CIRCUIT Function) 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.

Syntax

FUNCTION bulk_delete_virtual_circuit_public_prefixes (
  virtual_circuit_id varchar2,
  bulk_delete_virtual_circuit_public_prefixes_details dbms_cloud_oci_core_bulk_delete_virtual_circuit_public_prefixes_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_bulk_delete_virtual_circuit_public_prefixes_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`bulk_delete_virtual_circuit_public_prefixes_details`	(required) Request with public prefixes to be deleted from the virtual circuit.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_BYOIP_RANGE_COMPARTMENT Function

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

Syntax

FUNCTION change_byoip_range_compartment (
  byoip_range_id varchar2,
  change_byoip_range_compartment_details dbms_cloud_oci_core_change_byoip_range_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_byoip_range_compartment_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`change_byoip_range_compartment_details`	(required) Request to change the compartment of a BYOIP CIDR block.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_CAPTURE_FILTER_COMPARTMENT Function

Moves a capture filter to a new compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_capture_filter_compartment (
  capture_filter_id varchar2,
  change_capture_filter_compartment_details dbms_cloud_oci_core_change_capture_filter_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_capture_filter_compartment_response_t;

Parameters

Parameter	Description
`capture_filter_id`	(required) The OCID of the capture filter.
`change_capture_filter_compartment_details`	(required) Request to change the compartment of a VTAP.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_CPE_COMPARTMENT Function

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.

Syntax

FUNCTION change_cpe_compartment (
  cpe_id varchar2,
  change_cpe_compartment_details dbms_cloud_oci_core_change_cpe_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_cpe_compartment_response_t;

Parameters

Parameter	Description
`cpe_id`	(required) The OCID of the CPE.
`change_cpe_compartment_details`	(required) Request to change the compartment of a CPE.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_CROSS_CONNECT_COMPARTMENT Function

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.

Syntax

FUNCTION change_cross_connect_compartment (
  cross_connect_id varchar2,
  change_cross_connect_compartment_details dbms_cloud_oci_core_change_cross_connect_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_cross_connect_compartment_response_t;

Parameters

Parameter	Description
`cross_connect_id`	(required) The OCID of the cross-connect.
`change_cross_connect_compartment_details`	(required) Request to change the compartment of a Cross Connect.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_CROSS_CONNECT_GROUP_COMPARTMENT Function

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.

Syntax

FUNCTION change_cross_connect_group_compartment (
  cross_connect_group_id varchar2,
  change_cross_connect_group_compartment_details dbms_cloud_oci_core_change_cross_connect_group_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_cross_connect_group_compartment_response_t;

Parameters

Parameter	Description
`cross_connect_group_id`	(required) The OCID of the cross-connect group.
`change_cross_connect_group_compartment_details`	(required) Request to change the compartment of a Cross Connect Group.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DHCP_OPTIONS_COMPARTMENT Function

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.

Syntax

FUNCTION change_dhcp_options_compartment (
  dhcp_id varchar2,
  change_dhcp_options_compartment_details dbms_cloud_oci_core_change_dhcp_options_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_dhcp_options_compartment_response_t;

Parameters

Parameter	Description
`dhcp_id`	(required) The OCID for the set of DHCP options.
`change_dhcp_options_compartment_details`	(required) Request to change the compartment of a set of DHCP Options.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_DRG_COMPARTMENT Function

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.

Syntax

FUNCTION change_drg_compartment (
  drg_id varchar2,
  change_drg_compartment_details dbms_cloud_oci_core_change_drg_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_drg_compartment_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`change_drg_compartment_details`	(required) Request to change the compartment of a DRG.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_IP_SEC_CONNECTION_COMPARTMENT Function

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.

Syntax

FUNCTION change_ip_sec_connection_compartment (
  ipsc_id varchar2,
  change_ip_sec_connection_compartment_details dbms_cloud_oci_core_change_ip_sec_connection_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_ip_sec_connection_compartment_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`change_ip_sec_connection_compartment_details`	(required) Request to change the compartment of a IPSec connection.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_INTERNET_GATEWAY_COMPARTMENT Function

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.

Syntax

FUNCTION change_internet_gateway_compartment (
  ig_id varchar2,
  change_internet_gateway_compartment_details dbms_cloud_oci_core_change_internet_gateway_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_internet_gateway_compartment_response_t;

Parameters

Parameter	Description
`ig_id`	(required) The OCID of the internet gateway.
`change_internet_gateway_compartment_details`	(required) Request to change the compartment of an internet gateway.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_LOCAL_PEERING_GATEWAY_COMPARTMENT Function

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.

Syntax

FUNCTION change_local_peering_gateway_compartment (
  local_peering_gateway_id varchar2,
  change_local_peering_gateway_compartment_details dbms_cloud_oci_core_change_local_peering_gateway_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_local_peering_gateway_compartment_response_t;

Parameters

Parameter	Description
`local_peering_gateway_id`	(required) The OCID of the local peering gateway.
`change_local_peering_gateway_compartment_details`	(required) Request to change the compartment of a given local peering gateway.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_NAT_GATEWAY_COMPARTMENT Function

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.

Syntax

FUNCTION change_nat_gateway_compartment (
  nat_gateway_id varchar2,
  change_nat_gateway_compartment_details dbms_cloud_oci_core_change_nat_gateway_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_nat_gateway_compartment_response_t;

Parameters

Parameter	Description
`nat_gateway_id`	(required) The NAT gateway's OCID.
`change_nat_gateway_compartment_details`	(required) Request to change the compartment of a given NAT Gateway.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_NETWORK_SECURITY_GROUP_COMPARTMENT Function

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.

Syntax

FUNCTION change_network_security_group_compartment (
  network_security_group_id varchar2,
  change_network_security_group_compartment_details dbms_cloud_oci_core_change_network_security_group_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_network_security_group_compartment_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`change_network_security_group_compartment_details`	(required) Request to change the compartment of a network security group.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PUBLIC_IP_COMPARTMENT Function

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.

Syntax

FUNCTION change_public_ip_compartment (
  public_ip_id varchar2,
  change_public_ip_compartment_details dbms_cloud_oci_core_change_public_ip_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_public_ip_compartment_response_t;

Parameters

Parameter	Description
`public_ip_id`	(required) The OCID of the public IP.
`change_public_ip_compartment_details`	(required) Request to change the compartment of a Public IP.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_PUBLIC_IP_POOL_COMPARTMENT Function

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

Syntax

FUNCTION change_public_ip_pool_compartment (
  public_ip_pool_id varchar2,
  change_public_ip_pool_compartment_details dbms_cloud_oci_core_change_public_ip_pool_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_public_ip_pool_compartment_response_t;

Parameters

Parameter	Description
`public_ip_pool_id`	(required) The OCID of the public IP pool.
`change_public_ip_pool_compartment_details`	(required) Request to change the compartment of a public IP pool.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_REMOTE_PEERING_CONNECTION_COMPARTMENT Function

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.

Syntax

FUNCTION change_remote_peering_connection_compartment (
  remote_peering_connection_id varchar2,
  change_remote_peering_connection_compartment_details dbms_cloud_oci_core_change_remote_peering_connection_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_remote_peering_connection_compartment_response_t;

Parameters

Parameter	Description
`remote_peering_connection_id`	(required) The OCID of the remote peering connection (RPC).
`change_remote_peering_connection_compartment_details`	(required) Request to change the compartment of a remote peering connection.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_ROUTE_TABLE_COMPARTMENT Function

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.

Syntax

FUNCTION change_route_table_compartment (
  rt_id varchar2,
  change_route_table_compartment_details dbms_cloud_oci_core_change_route_table_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_route_table_compartment_response_t;

Parameters

Parameter	Description
`rt_id`	(required) The OCID of the route table.
`change_route_table_compartment_details`	(required) Request to change the compartment of a given route table.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SECURITY_LIST_COMPARTMENT Function

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.

Syntax

FUNCTION change_security_list_compartment (
  security_list_id varchar2,
  change_security_list_compartment_details dbms_cloud_oci_core_change_security_list_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_security_list_compartment_response_t;

Parameters

Parameter	Description
`security_list_id`	(required) The OCID of the security list.
`change_security_list_compartment_details`	(required) Request to change the compartment of a given security list.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SERVICE_GATEWAY_COMPARTMENT Function

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.

Syntax

FUNCTION change_service_gateway_compartment (
  service_gateway_id varchar2,
  change_service_gateway_compartment_details dbms_cloud_oci_core_change_service_gateway_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_service_gateway_compartment_response_t;

Parameters

Parameter	Description
`service_gateway_id`	(required) The service gateway's OCID.
`change_service_gateway_compartment_details`	(required) Request to change the compartment of a given Service Gateway.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_SUBNET_COMPARTMENT Function

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.

Syntax

FUNCTION change_subnet_compartment (
  subnet_id varchar2,
  change_subnet_compartment_details dbms_cloud_oci_core_change_subnet_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_subnet_compartment_response_t;

Parameters

Parameter	Description
`subnet_id`	(required) The OCID of the subnet.
`change_subnet_compartment_details`	(required) Request to change the compartment of a given subnet.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VCN_COMPARTMENT Function

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.

Syntax

FUNCTION change_vcn_compartment (
  vcn_id varchar2,
  change_vcn_compartment_details dbms_cloud_oci_core_change_vcn_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_vcn_compartment_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`change_vcn_compartment_details`	(required) Request to change the compartment of a given VCN.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VIRTUAL_CIRCUIT_COMPARTMENT Function

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.

Syntax

FUNCTION change_virtual_circuit_compartment (
  virtual_circuit_id varchar2,
  change_virtual_circuit_compartment_details dbms_cloud_oci_core_change_virtual_circuit_compartment_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_virtual_circuit_compartment_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`change_virtual_circuit_compartment_details`	(required) Request to change the compartment of a virtual circuit.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VLAN_COMPARTMENT Function

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.

Syntax

FUNCTION change_vlan_compartment (
  vlan_id varchar2,
  change_vlan_compartment_details dbms_cloud_oci_core_change_vlan_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_vlan_compartment_response_t;

Parameters

Parameter	Description
`vlan_id`	(required) The OCID of the VLAN.
`change_vlan_compartment_details`	(required) Request to change the compartment of a given VLAN.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CHANGE_VTAP_COMPARTMENT Function

Moves a VTAP to a new compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.

Syntax

FUNCTION change_vtap_compartment (
  vtap_id varchar2,
  change_vtap_compartment_details dbms_cloud_oci_core_change_vtap_compartment_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_change_vtap_compartment_response_t;

Parameters

Parameter	Description
`vtap_id`	(required) The OCID of the VTAP.
`change_vtap_compartment_details`	(required) Request to change the compartment that contains a VTAP.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CONNECT_LOCAL_PEERING_GATEWAYS Function

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.

Syntax

FUNCTION connect_local_peering_gateways (
  local_peering_gateway_id varchar2,
  connect_local_peering_gateways_details dbms_cloud_oci_core_connect_local_peering_gateways_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_connect_local_peering_gateways_response_t;

Parameters

Parameter	Description
`local_peering_gateway_id`	(required) The OCID of the local peering gateway.
`connect_local_peering_gateways_details`	(required) Details regarding the local peering gateway to connect.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CONNECT_REMOTE_PEERING_CONNECTIONS Function

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.

Syntax

FUNCTION connect_remote_peering_connections (
  remote_peering_connection_id varchar2,
  connect_remote_peering_connections_details dbms_cloud_oci_core_connect_remote_peering_connections_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_connect_remote_peering_connections_response_t;

Parameters

Parameter	Description
`remote_peering_connection_id`	(required) The OCID of the remote peering connection (RPC).
`connect_remote_peering_connections_details`	(required) Details to connect peering connection with peering connection from remote region
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_BYOIP_RANGE Function

Creates a subrange of the BYOIP CIDR block.

Syntax

FUNCTION create_byoip_range (
  create_byoip_range_details dbms_cloud_oci_core_create_byoip_range_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_byoip_range_response_t;

Parameters

Parameter	Description
`create_byoip_range_details`	(required) Details needed to create a BYOIP CIDR block subrange.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CAPTURE_FILTER Function

Creates a virtual test access point (VTAP) capture filter in the specified compartment. For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. You may optionally specify a *display name* for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.

Syntax

FUNCTION create_capture_filter (
  create_capture_filter_details dbms_cloud_oci_core_create_capture_filter_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_capture_filter_response_t;

Parameters

Parameter	Description
`create_capture_filter_details`	(required) Details for creating a capture filter.
`opc_retry_token`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CPE Function

Creates a new virtual customer-premises equipment (CPE) object in the specified compartment. For more information, see Site-to-Site VPN Overview. For the purposes of access control, you must provide the OCID of the compartment where you want the CPE to reside. Notice that the CPE doesn't have to be in the same compartment as the IPSec connection or other Networking Service components. If you're not sure which compartment to use, put the CPE in the same compartment as the DRG. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. You must provide the public IP address of your on-premises router. See CPE Configuration. You may optionally specify a *display name* for the CPE, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

Syntax

FUNCTION create_cpe (
  create_cpe_details dbms_cloud_oci_core_create_cpe_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_cpe_response_t;

Parameters

Parameter	Description
`create_cpe_details`	(required) Details for creating a CPE.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CROSS_CONNECT Function

Creates a new cross-connect. Oracle recommends you create each cross-connect in a CROSS_CONNECT_GROUP Type 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.

Syntax

FUNCTION create_cross_connect (
  create_cross_connect_details dbms_cloud_oci_core_create_cross_connect_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_cross_connect_response_t;

Parameters

Parameter	Description
`create_cross_connect_details`	(required) Details to create a CrossConnect
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_CROSS_CONNECT_GROUP Function

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.

Syntax

FUNCTION create_cross_connect_group (
  create_cross_connect_group_details dbms_cloud_oci_core_create_cross_connect_group_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_cross_connect_group_response_t;

Parameters

Parameter	Description
`create_cross_connect_group_details`	(required) Details to create a CrossConnectGroup
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DHCP_OPTIONS Function

Creates a new set of DHCP options for the specified VCN. For more information, see DHCP_OPTIONS Type. 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.

Syntax

FUNCTION create_dhcp_options (
  create_dhcp_details dbms_cloud_oci_core_create_dhcp_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_dhcp_options_response_t;

Parameters

Parameter	Description
`create_dhcp_details`	(required) Request object for creating a new set of DHCP options.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DRG Function

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.

Syntax

FUNCTION create_drg (
  create_drg_details dbms_cloud_oci_core_create_drg_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_drg_response_t;

Parameters

Parameter	Description
`create_drg_details`	(required) Details for creating a DRG.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DRG_ATTACHMENT Function

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.

Syntax

FUNCTION create_drg_attachment (
  create_drg_attachment_details dbms_cloud_oci_core_create_drg_attachment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_drg_attachment_response_t;

Parameters

Parameter	Description
`create_drg_attachment_details`	(required) Details for creating a `DrgAttachment`.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DRG_ROUTE_DISTRIBUTION Function

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.

Syntax

FUNCTION create_drg_route_distribution (
  create_drg_route_distribution_details dbms_cloud_oci_core_create_drg_route_distribution_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_drg_route_distribution_response_t;

Parameters

Parameter	Description
`create_drg_route_distribution_details`	(required) Details for creating a route distribution.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_DRG_ROUTE_TABLE Function

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.

Syntax

FUNCTION create_drg_route_table (
  create_drg_route_table_details dbms_cloud_oci_core_create_drg_route_table_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_drg_route_table_response_t;

Parameters

Parameter	Description
`create_drg_route_table_details`	(required) Details for creating a DRG route table.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_IP_SEC_CONNECTION Function

Creates a new IPSec connection between the specified DRG and CPE. For more information, see Site-to-Site VPN Overview. If you configure at least one tunnel to use static routing, then in the request you must provide at least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. For more information, see the important note in IP_SEC_CONNECTION Type. 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: * IP_SEC_CONNECTION_TUNNEL Type * IP_SEC_CONNECTION_TUNNEL_SHARED_SECRET Type For each tunnel, you need the IP address of Oracle's VPN headend and the shared secret (that is, the pre-shared key). For more information, see CPE Configuration.

Syntax

FUNCTION create_ip_sec_connection (
  create_ip_sec_connection_details dbms_cloud_oci_core_create_ip_sec_connection_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_ip_sec_connection_response_t;

Parameters

Parameter	Description
`create_ip_sec_connection_details`	(required) Details for creating an `IPSecConnection`.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_INTERNET_GATEWAY Function

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 Function. 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 Function to easily disable/enable the gateway without changing the route rule.

Syntax

FUNCTION create_internet_gateway (
  create_internet_gateway_details dbms_cloud_oci_core_create_internet_gateway_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_internet_gateway_response_t;

Parameters

Parameter	Description
`create_internet_gateway_details`	(required) Details for creating a new internet gateway.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_IPV6 Function

Creates an IPv6 for the specified VNIC.

Syntax

FUNCTION create_ipv6 (
  create_ipv6_details dbms_cloud_oci_core_create_ipv6_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_ipv6_response_t;

Parameters

Parameter	Description
`create_ipv6_details`	(required) Create IPv6 details.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_LOCAL_PEERING_GATEWAY Function

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

Syntax

FUNCTION create_local_peering_gateway (
  create_local_peering_gateway_details dbms_cloud_oci_core_create_local_peering_gateway_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_local_peering_gateway_response_t;

Parameters

Parameter	Description
`create_local_peering_gateway_details`	(required) Details for creating a new local peering gateway.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_NAT_GATEWAY Function

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 ROUTE_TABLE Type.

Syntax

FUNCTION create_nat_gateway (
  create_nat_gateway_details dbms_cloud_oci_core_create_nat_gateway_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_nat_gateway_response_t;

Parameters

Parameter	Description
`create_nat_gateway_details`	(required) Details for creating a NAT gateway.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_NETWORK_SECURITY_GROUP Function

Creates a new network security group for the specified VCN.

Syntax

FUNCTION create_network_security_group (
  create_network_security_group_details dbms_cloud_oci_core_create_network_security_group_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_network_security_group_response_t;

Parameters

Parameter	Description
`create_network_security_group_details`	(required) Details for creating a network security group.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PRIVATE_IP Function

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

Syntax

FUNCTION create_private_ip (
  create_private_ip_details dbms_cloud_oci_core_create_private_ip_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_private_ip_response_t;

Parameters

Parameter	Description
`create_private_ip_details`	(required) Create private IP details.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PUBLIC_IP Function

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 NAT_GATEWAY Type, 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 Function. **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.

Syntax

FUNCTION create_public_ip (
  create_public_ip_details dbms_cloud_oci_core_create_public_ip_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_public_ip_response_t;

Parameters

Parameter	Description
`create_public_ip_details`	(required) Create public IP details.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_PUBLIC_IP_POOL Function

Creates a public IP pool.

Syntax

FUNCTION create_public_ip_pool (
  create_public_ip_pool_details dbms_cloud_oci_core_create_public_ip_pool_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_public_ip_pool_response_t;

Parameters

Parameter	Description
`create_public_ip_pool_details`	(required) Create Public Ip Pool details
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_REMOTE_PEERING_CONNECTION Function

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

Syntax

FUNCTION create_remote_peering_connection (
  create_remote_peering_connection_details dbms_cloud_oci_core_create_remote_peering_connection_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_remote_peering_connection_response_t;

Parameters

Parameter	Description
`create_remote_peering_connection_details`	(required) Request to create peering connection to remote region
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_ROUTE_TABLE Function

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.

Syntax

FUNCTION create_route_table (
  create_route_table_details dbms_cloud_oci_core_create_route_table_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_route_table_response_t;

Parameters

Parameter	Description
`create_route_table_details`	(required) Details for creating a new route table.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SECURITY_LIST Function

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.

Syntax

FUNCTION create_security_list (
  create_security_list_details dbms_cloud_oci_core_create_security_list_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_security_list_response_t;

Parameters

Parameter	Description
`create_security_list_details`	(required) Details regarding the security list to create.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SERVICE_GATEWAY Function

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.

Syntax

FUNCTION create_service_gateway (
  create_service_gateway_details dbms_cloud_oci_core_create_service_gateway_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_service_gateway_response_t;

Parameters

Parameter	Description
`create_service_gateway_details`	(required) Details for creating a service gateway.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_SUBNET Function

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.

Syntax

FUNCTION create_subnet (
  create_subnet_details dbms_cloud_oci_core_create_subnet_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_subnet_response_t;

Parameters

Parameter	Description
`create_subnet_details`	(required) Details for creating a subnet.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VCN Function

Creates a new virtual cloud network (VCN). For more information, see VCNs and Subnets. For the VCN, you specify a list of one or more IPv4 CIDR blocks that meet the following criteria: - The CIDR blocks must be valid. - They must not overlap with each other or with the on-premises network CIDR block. - The number of CIDR blocks does not exceed the limit of CIDR blocks allowed per VCN. For a CIDR block, Oracle recommends that you use one of the private IP address ranges specified in RFC 1918 (10.0.0.0/8, 172.16/12, and 192.168/16). Example: 172.16.0.0/16. The CIDR blocks can range from /16 to /30. For the purposes of access control, you must provide the OCID of the compartment where you want the VCN to reside. Consult an Oracle Cloud Infrastructure administrator in your organization if you're not sure which compartment to use. Notice that the VCN doesn't have to be in the same compartment as the subnets or other Networking Service components. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. You may optionally specify a *display name* for the VCN, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information. You can also add a DNS label for the VCN, which is required if you want the instances to use the Interent and VCN Resolver option for DNS in the VCN. For more information, see DNS in Your Virtual Cloud Network. The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The OCID for each is returned in the response. You can't delete these default objects, but you can change their contents (that is, change the route rules, security list rules, and so on). The VCN and subnets you create are not accessible until you attach an internet gateway or set up a Site-to-Site VPN or FastConnect. For more information, see Overview of the Networking Service.

Syntax

FUNCTION create_vcn (
  create_vcn_details dbms_cloud_oci_core_create_vcn_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_vcn_response_t;

Parameters

Parameter	Description
`create_vcn_details`	(required) Details for creating a new VCN.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VIRTUAL_CIRCUIT Function

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.

Syntax

FUNCTION create_virtual_circuit (
  create_virtual_circuit_details dbms_cloud_oci_core_create_virtual_circuit_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_virtual_circuit_response_t;

Parameters

Parameter	Description
`create_virtual_circuit_details`	(required) Details to create a VirtualCircuit.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VLAN Function

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

Syntax

FUNCTION create_vlan (
  create_vlan_details dbms_cloud_oci_core_create_vlan_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_vlan_response_t;

Parameters

Parameter	Description
`create_vlan_details`	(required) Details for creating a VLAN
`opc_retry_token`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_VTAP Function

Creates a virtual test access point (VTAP) in the specified compartment. For the purposes of access control, you must provide the OCID of the compartment that contains the VTAP. For more information about compartments and access control, see Overview of the IAM Service. For information about OCIDs, see Resource Identifiers. You may optionally specify a *display name* for the VTAP, otherwise a default is provided. It does not have to be unique, and you can change it.

Syntax

FUNCTION create_vtap (
  create_vtap_details dbms_cloud_oci_core_create_vtap_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_create_vtap_response_t;

Parameters

Parameter	Description
`create_vtap_details`	(required) Details used to create a VTAP.
`opc_retry_token`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_BYOIP_RANGE Function

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.

Syntax

FUNCTION delete_byoip_range (
  byoip_range_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_byoip_range_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CAPTURE_FILTER Function

Deletes the specified VTAP capture filter. This is an asynchronous operation. The VTAP capture filter's `lifecycleState` will change to TERMINATING temporarily until the VTAP capture filter is completely removed.

Syntax

FUNCTION delete_capture_filter (
  capture_filter_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_capture_filter_response_t;

Parameters

Parameter	Description
`capture_filter_id`	(required) The OCID of the capture filter.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CPE Function

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.

Syntax

FUNCTION delete_cpe (
  cpe_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_cpe_response_t;

Parameters

Parameter	Description
`cpe_id`	(required) The OCID of the CPE.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CROSS_CONNECT Function

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

Syntax

FUNCTION delete_cross_connect (
  cross_connect_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_cross_connect_response_t;

Parameters

Parameter	Description
`cross_connect_id`	(required) The OCID of the cross-connect.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_CROSS_CONNECT_GROUP Function

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

Syntax

FUNCTION delete_cross_connect_group (
  cross_connect_group_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_cross_connect_group_response_t;

Parameters

Parameter	Description
`cross_connect_group_id`	(required) The OCID of the cross-connect group.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DHCP_OPTIONS Function

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.

Syntax

FUNCTION delete_dhcp_options (
  dhcp_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_dhcp_options_response_t;

Parameters

Parameter	Description
`dhcp_id`	(required) The OCID for the set of DHCP options.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DRG Function

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.

Syntax

FUNCTION delete_drg (
  drg_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_drg_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DRG_ATTACHMENT Function

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.

Syntax

FUNCTION delete_drg_attachment (
  drg_attachment_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_drg_attachment_response_t;

Parameters

Parameter	Description
`drg_attachment_id`	(required) The OCID of the DRG attachment.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DRG_ROUTE_DISTRIBUTION Function

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.

Syntax

FUNCTION delete_drg_route_distribution (
  drg_route_distribution_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_drg_route_distribution_response_t;

Parameters

Parameter	Description
`drg_route_distribution_id`	(required) The OCID of the route distribution.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_DRG_ROUTE_TABLE Function

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

Syntax

FUNCTION delete_drg_route_table (
  drg_route_table_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_drg_route_table_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_IP_SEC_CONNECTION Function

Deletes the specified IPSec connection. If your goal is to disable the Site-to-Site VPN between your VCN and on-premises network, it's easiest to simply detach the DRG but keep all the Site-to-Site VPN components intact. If you were to delete all the components and then later need to create an Site-to-Site VPN again, you would need to configure your on-premises router again with the new information returned from CREATE_IP_SEC_CONNECTION Function. This is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily until the connection is completely removed.

Syntax

FUNCTION delete_ip_sec_connection (
  ipsc_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_ip_sec_connection_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_INTERNET_GATEWAY Function

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.

Syntax

FUNCTION delete_internet_gateway (
  ig_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_internet_gateway_response_t;

Parameters

Parameter	Description
`ig_id`	(required) The OCID of the internet gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_IPV6 Function

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.

Syntax

FUNCTION delete_ipv6 (
  ipv6_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_ipv6_response_t;

Parameters

Parameter	Description
`ipv6_id`	(required) The OCID of the IPv6.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_LOCAL_PEERING_GATEWAY Function

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.

Syntax

FUNCTION delete_local_peering_gateway (
  local_peering_gateway_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_local_peering_gateway_response_t;

Parameters

Parameter	Description
`local_peering_gateway_id`	(required) The OCID of the local peering gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_NAT_GATEWAY Function

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.

Syntax

FUNCTION delete_nat_gateway (
  nat_gateway_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_nat_gateway_response_t;

Parameters

Parameter	Description
`nat_gateway_id`	(required) The NAT gateway's OCID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_NETWORK_SECURITY_GROUP Function

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 Function. Each returned NETWORK_SECURITY_GROUP_VNIC Type 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).

Syntax

FUNCTION delete_network_security_group (
  network_security_group_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_network_security_group_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PRIVATE_IP Function

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.

Syntax

FUNCTION delete_private_ip (
  private_ip_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_private_ip_response_t;

Parameters

Parameter	Description
`private_ip_id`	(required) The OCID of the private IP or IPv6.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PUBLIC_IP Function

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 Function.

Syntax

FUNCTION delete_public_ip (
  public_ip_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_public_ip_response_t;

Parameters

Parameter	Description
`public_ip_id`	(required) The OCID of the public IP.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_PUBLIC_IP_POOL Function

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.

Syntax

FUNCTION delete_public_ip_pool (
  public_ip_pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_public_ip_pool_response_t;

Parameters

Parameter	Description
`public_ip_pool_id`	(required) The OCID of the public IP pool.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REMOTE_PEERING_CONNECTION Function

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.

Syntax

FUNCTION delete_remote_peering_connection (
  remote_peering_connection_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_remote_peering_connection_response_t;

Parameters

Parameter	Description
`remote_peering_connection_id`	(required) The OCID of the remote peering connection (RPC).
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ROUTE_TABLE Function

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.

Syntax

FUNCTION delete_route_table (
  rt_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_route_table_response_t;

Parameters

Parameter	Description
`rt_id`	(required) The OCID of the route table.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SECURITY_LIST Function

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.

Syntax

FUNCTION delete_security_list (
  security_list_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_security_list_response_t;

Parameters

Parameter	Description
`security_list_id`	(required) The OCID of the security list.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SERVICE_GATEWAY Function

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

Syntax

FUNCTION delete_service_gateway (
  service_gateway_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_service_gateway_response_t;

Parameters

Parameter	Description
`service_gateway_id`	(required) The service gateway's OCID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_SUBNET Function

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.

Syntax

FUNCTION delete_subnet (
  subnet_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_subnet_response_t;

Parameters

Parameter	Description
`subnet_id`	(required) The OCID of the subnet.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VCN Function

Deletes the specified VCN. The VCN must be completely empty and have no attached gateways. This is an asynchronous operation. A deleted VCN's `lifecycleState` changes to TERMINATING and then TERMINATED temporarily until the VCN is completely removed. A completely removed VCN does not appear in the results of a `ListVcns` operation and can't be used in a `GetVcn` operation.

Syntax

FUNCTION delete_vcn (
  vcn_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_vcn_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VIRTUAL_CIRCUIT Function

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.

Syntax

FUNCTION delete_virtual_circuit (
  virtual_circuit_id varchar2,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_virtual_circuit_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VLAN Function

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

Syntax

FUNCTION delete_vlan (
  vlan_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_vlan_response_t;

Parameters

Parameter	Description
`vlan_id`	(required) The OCID of the VLAN.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_VTAP Function

Deletes the specified VTAP. This is an asynchronous operation. The VTAP's `lifecycleState` will change to TERMINATING temporarily until the VTAP is completely removed.

Syntax

FUNCTION delete_vtap (
  vtap_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_delete_vtap_response_t;

Parameters

Parameter	Description
`vtap_id`	(required) The OCID of the VTAP.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DETACH_SERVICE_ID Function

Removes the specified SERVICE Type 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 Function, 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.

Syntax

FUNCTION detach_service_id (
  service_gateway_id varchar2,
  detach_service_details dbms_cloud_oci_core_service_id_request_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_detach_service_id_response_t;

Parameters

Parameter	Description
`service_gateway_id`	(required) The service gateway's OCID.
`detach_service_details`	(required) ServiceId of Service to be detached from a service gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ALL_DRG_ATTACHMENTS Function

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

Syntax

FUNCTION get_all_drg_attachments (
  drg_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  attachment_type varchar2 DEFAULT NULL,
  is_cross_tenancy number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_all_drg_attachments_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(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`	(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`	(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`	(optional) Whether the DRG attachment lives in a different tenancy than the DRG.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ALLOWED_IKE_IP_SEC_PARAMETERS Function

The parameters allowed for IKE IPSec tunnels.

Syntax

FUNCTION get_allowed_ike_ip_sec_parameters (
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_allowed_ike_ip_sec_parameters_response_t;

Parameters

Parameter	Description
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_BYOIP_RANGE Function

Gets the `ByoipRange` resource. You must specify the OCID.

Syntax

FUNCTION get_byoip_range (
  byoip_range_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_byoip_range_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CAPTURE_FILTER Function

Gets information about the specified VTAP capture filter.

Syntax

FUNCTION get_capture_filter (
  capture_filter_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_capture_filter_response_t;

Parameters

Parameter	Description
`capture_filter_id`	(required) The OCID of the capture filter.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CPE Function

Gets the specified CPE's information.

Syntax

FUNCTION get_cpe (
  cpe_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_cpe_response_t;

Parameters

Parameter	Description
`cpe_id`	(required) The OCID of the CPE.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CPE_DEVICE_CONFIG_CONTENT Function

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 Type object. The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the CPE Type 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 Function), merged with a template of other information specific to the CPE device type. The operation returns configuration information for *all* of the IP_SEC_CONNECTION Type objects that use the specified CPE. Here are similar operations: * GET_IPSEC_CPE_DEVICE_CONFIG_CONTENT Function returns CPE configuration content for all IPSec tunnels in a single IPSec connection. * GET_TUNNEL_CPE_DEVICE_CONFIG_CONTENT Function returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.

Syntax

FUNCTION get_cpe_device_config_content (
  cpe_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_cpe_device_config_content_response_t;

Parameters

Parameter	Description
`cpe_id`	(required) The OCID of the CPE.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CPE_DEVICE_SHAPE Function

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 Function). The service merges the answers with a template of other information for the CPE device type. The following operations return the merged content: * GET_CPE_DEVICE_CONFIG_CONTENT Function * GET_IPSEC_CPE_DEVICE_CONFIG_CONTENT Function * GET_TUNNEL_CPE_DEVICE_CONFIG_CONTENT Function

Syntax

FUNCTION get_cpe_device_shape (
  cpe_device_shape_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_cpe_device_shape_response_t;

Parameters

Parameter	Description
`cpe_device_shape_id`	(required) The OCID of the CPE device shape.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CROSS_CONNECT Function

Gets the specified cross-connect's information.

Syntax

FUNCTION get_cross_connect (
  cross_connect_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_cross_connect_response_t;

Parameters

Parameter	Description
`cross_connect_id`	(required) The OCID of the cross-connect.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CROSS_CONNECT_GROUP Function

Gets the specified cross-connect group's information.

Syntax

FUNCTION get_cross_connect_group (
  cross_connect_group_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_cross_connect_group_response_t;

Parameters

Parameter	Description
`cross_connect_group_id`	(required) The OCID of the cross-connect group.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CROSS_CONNECT_LETTER_OF_AUTHORITY Function

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

Syntax

FUNCTION get_cross_connect_letter_of_authority (
  cross_connect_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_cross_connect_letter_of_authority_response_t;

Parameters

Parameter	Description
`cross_connect_id`	(required) The OCID of the cross-connect.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_CROSS_CONNECT_STATUS Function

Gets the status of the specified cross-connect.

Syntax

FUNCTION get_cross_connect_status (
  cross_connect_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_cross_connect_status_response_t;

Parameters

Parameter	Description
`cross_connect_id`	(required) The OCID of the cross-connect.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DHCP_OPTIONS Function

Gets the specified set of DHCP options.

Syntax

FUNCTION get_dhcp_options (
  dhcp_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_dhcp_options_response_t;

Parameters

Parameter	Description
`dhcp_id`	(required) The OCID for the set of DHCP options.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DRG Function

Gets the specified DRG's information.

Syntax

FUNCTION get_drg (
  drg_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_drg_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DRG_ATTACHMENT Function

Gets the `DrgAttachment` resource.

Syntax

FUNCTION get_drg_attachment (
  drg_attachment_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_drg_attachment_response_t;

Parameters

Parameter	Description
`drg_attachment_id`	(required) The OCID of the DRG attachment.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DRG_REDUNDANCY_STATUS Function

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

Syntax

FUNCTION get_drg_redundancy_status (
  drg_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_drg_redundancy_status_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DRG_ROUTE_DISTRIBUTION Function

Gets the specified route distribution's information.

Syntax

FUNCTION get_drg_route_distribution (
  drg_route_distribution_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_drg_route_distribution_response_t;

Parameters

Parameter	Description
`drg_route_distribution_id`	(required) The OCID of the route distribution.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_DRG_ROUTE_TABLE Function

Gets the specified DRG route table's information.

Syntax

FUNCTION get_drg_route_table (
  drg_route_table_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_drg_route_table_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_FAST_CONNECT_PROVIDER_SERVICE Function

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

Syntax

FUNCTION get_fast_connect_provider_service (
  provider_service_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_fast_connect_provider_service_response_t;

Parameters

Parameter	Description
`provider_service_id`	(required) The OCID of the provider service.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_FAST_CONNECT_PROVIDER_SERVICE_KEY Function

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

Syntax

FUNCTION get_fast_connect_provider_service_key (
  provider_service_id varchar2,
  provider_service_key_name varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_fast_connect_provider_service_key_response_t;

Parameters

Parameter	Description
`provider_service_id`	(required) The OCID of the provider service.
`provider_service_key_name`	(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 `FAST_CONNECT_PROVIDER_SERVICE` Type.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IP_SEC_CONNECTION Function

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 Function.

Syntax

FUNCTION get_ip_sec_connection (
  ipsc_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ip_sec_connection_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IP_SEC_CONNECTION_DEVICE_CONFIG Function

Deprecated. To get tunnel information, instead use: * GET_IP_SEC_CONNECTION_TUNNEL Function * GET_IP_SEC_CONNECTION_TUNNEL_SHARED_SECRET Function

Syntax

FUNCTION get_ip_sec_connection_device_config (
  ipsc_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ip_sec_connection_device_config_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IP_SEC_CONNECTION_DEVICE_STATUS Function

Deprecated. To get the tunnel status, instead use GET_IP_SEC_CONNECTION_TUNNEL Function.

Syntax

FUNCTION get_ip_sec_connection_device_status (
  ipsc_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ip_sec_connection_device_status_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IP_SEC_CONNECTION_TUNNEL Function

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 Function.

Syntax

FUNCTION get_ip_sec_connection_tunnel (
  ipsc_id varchar2,
  tunnel_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ip_sec_connection_tunnel_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IP_SEC_CONNECTION_TUNNEL_ERROR Function

Gets the identified error for the specified IPSec tunnel ID.

Syntax

FUNCTION get_ip_sec_connection_tunnel_error (
  ipsc_id varchar2,
  tunnel_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ip_sec_connection_tunnel_error_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IP_SEC_CONNECTION_TUNNEL_SHARED_SECRET Function

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

Syntax

FUNCTION get_ip_sec_connection_tunnel_shared_secret (
  ipsc_id varchar2,
  tunnel_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ip_sec_connection_tunnel_shared_secret_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_INTERNET_GATEWAY Function

Gets the specified internet gateway's information.

Syntax

FUNCTION get_internet_gateway (
  ig_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_internet_gateway_response_t;

Parameters

Parameter	Description
`ig_id`	(required) The OCID of the internet gateway.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IPSEC_CPE_DEVICE_CONFIG_CONTENT Function

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 Type used by the specified IP_SEC_CONNECTION Type 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 Function), 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 IP_SEC_CONNECTION Type object. Here are other similar operations: * GET_TUNNEL_CPE_DEVICE_CONFIG_CONTENT Function returns CPE configuration content for a specific tunnel within an IPSec connection. * GET_CPE_DEVICE_CONFIG_CONTENT Function returns CPE configuration content for *all* IPSec connections that use a specific CPE.

Syntax

FUNCTION get_ipsec_cpe_device_config_content (
  ipsc_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ipsec_cpe_device_config_content_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_IPV6 Function

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

Syntax

FUNCTION get_ipv6 (
  ipv6_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_ipv6_response_t;

Parameters

Parameter	Description
`ipv6_id`	(required) The OCID of the IPv6.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_LOCAL_PEERING_GATEWAY Function

Gets the specified local peering gateway's information.

Syntax

FUNCTION get_local_peering_gateway (
  local_peering_gateway_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_local_peering_gateway_response_t;

Parameters

Parameter	Description
`local_peering_gateway_id`	(required) The OCID of the local peering gateway.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_NAT_GATEWAY Function

Gets the specified NAT gateway's information.

Syntax

FUNCTION get_nat_gateway (
  nat_gateway_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_nat_gateway_response_t;

Parameters

Parameter	Description
`nat_gateway_id`	(required) The NAT gateway's OCID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_NETWORK_SECURITY_GROUP Function

Gets the specified network security group's information. To list the VNICs in an NSG, see LIST_NETWORK_SECURITY_GROUP_VNICS Function. To list the security rules in an NSG, see LIST_NETWORK_SECURITY_GROUP_SECURITY_RULES Function.

Syntax

FUNCTION get_network_security_group (
  network_security_group_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_network_security_group_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_NETWORKING_TOPOLOGY Function

Gets a virtual networking topology for the current region.

Syntax

FUNCTION get_networking_topology (
  compartment_id varchar2,
  access_level varchar2 DEFAULT NULL,
  query_compartment_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  cache_control varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_networking_topology_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`access_level`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_none_match`	(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`	(optional) The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PRIVATE_IP Function

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

Syntax

FUNCTION get_private_ip (
  private_ip_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_private_ip_response_t;

Parameters

Parameter	Description
`private_ip_id`	(required) The OCID of the private IP or IPv6.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PUBLIC_IP Function

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 Function with the public IP address (for example, 203.0.113.2). Or you can use GET_PUBLIC_IP_BY_PRIVATE_IP_ID Function 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.

Syntax

FUNCTION get_public_ip (
  public_ip_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_public_ip_response_t;

Parameters

Parameter	Description
`public_ip_id`	(required) The OCID of the public IP.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PUBLIC_IP_BY_IP_ADDRESS Function

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.

Syntax

FUNCTION get_public_ip_by_ip_address (
  get_public_ip_by_ip_address_details dbms_cloud_oci_core_get_public_ip_by_ip_address_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_public_ip_by_ip_address_response_t;

Parameters

Parameter	Description
`get_public_ip_by_ip_address_details`	(required) IP address details for fetching the public IP.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PUBLIC_IP_BY_PRIVATE_IP_ID Function

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 Function or GET_PUBLIC_IP_BY_IP_ADDRESS Function, the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = OCID of the target private IP.

Syntax

FUNCTION get_public_ip_by_private_ip_id (
  get_public_ip_by_private_ip_id_details dbms_cloud_oci_core_get_public_ip_by_private_ip_id_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_public_ip_by_private_ip_id_response_t;

Parameters

Parameter	Description
`get_public_ip_by_private_ip_id_details`	(required) Private IP details for fetching the public IP.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_PUBLIC_IP_POOL Function

Gets the specified `PublicIpPool` object. You must specify the object's OCID.

Syntax

FUNCTION get_public_ip_pool (
  public_ip_pool_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_public_ip_pool_response_t;

Parameters

Parameter	Description
`public_ip_pool_id`	(required) The OCID of the public IP pool.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_REMOTE_PEERING_CONNECTION Function

Get the specified remote peering connection's information.

Syntax

FUNCTION get_remote_peering_connection (
  remote_peering_connection_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_remote_peering_connection_response_t;

Parameters

Parameter	Description
`remote_peering_connection_id`	(required) The OCID of the remote peering connection (RPC).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ROUTE_TABLE Function

Gets the specified route table's information.

Syntax

FUNCTION get_route_table (
  rt_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_route_table_response_t;

Parameters

Parameter	Description
`rt_id`	(required) The OCID of the route table.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SECURITY_LIST Function

Gets the specified security list's information.

Syntax

FUNCTION get_security_list (
  security_list_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_security_list_response_t;

Parameters

Parameter	Description
`security_list_id`	(required) The OCID of the security list.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SERVICE Function

Gets the specified SERVICE Type object.

Syntax

FUNCTION get_service (
  service_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_service_response_t;

Parameters

Parameter	Description
`service_id`	(required) The service's OCID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SERVICE_GATEWAY Function

Gets the specified service gateway's information.

Syntax

FUNCTION get_service_gateway (
  service_gateway_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_service_gateway_response_t;

Parameters

Parameter	Description
`service_gateway_id`	(required) The service gateway's OCID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SUBNET Function

Gets the specified subnet's information.

Syntax

FUNCTION get_subnet (
  subnet_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_subnet_response_t;

Parameters

Parameter	Description
`subnet_id`	(required) The OCID of the subnet.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_SUBNET_TOPOLOGY Function

Gets a topology for a given subnet.

Syntax

FUNCTION get_subnet_topology (
  compartment_id varchar2,
  subnet_id varchar2,
  access_level varchar2 DEFAULT NULL,
  query_compartment_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  cache_control varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_subnet_topology_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`subnet_id`	(required) The OCID of the subnet.
`access_level`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_none_match`	(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`	(optional) The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TUNNEL_CPE_DEVICE_CONFIG Function

Gets the set of CPE configuration answers for the tunnel, which the customer provided in UPDATE_TUNNEL_CPE_DEVICE_CONFIG Function. 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 Function.

Syntax

FUNCTION get_tunnel_cpe_device_config (
  ipsc_id varchar2,
  tunnel_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_tunnel_cpe_device_config_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TUNNEL_CPE_DEVICE_CONFIG_CONTENT Function

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 Type used by the specified IP_SEC_CONNECTION Type 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 Function), merged with a template of other information specific to the CPE device type. The operation returns configuration information for only the specified IPSec tunnel. Here are other similar operations: * GET_IPSEC_CPE_DEVICE_CONFIG_CONTENT Function returns CPE configuration content for all tunnels in a single IPSec connection. * GET_CPE_DEVICE_CONFIG_CONTENT Function returns CPE configuration content for *all* IPSec connections that use a specific CPE.

Syntax

FUNCTION get_tunnel_cpe_device_config_content (
  ipsc_id varchar2,
  tunnel_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_tunnel_cpe_device_config_content_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_UPGRADE_STATUS Function

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

Syntax

FUNCTION get_upgrade_status (
  drg_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_upgrade_status_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VCN Function

Gets the specified VCN's information.

Syntax

FUNCTION get_vcn (
  vcn_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_vcn_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VCN_DNS_RESOLVER_ASSOCIATION Function

Get the associated DNS resolver information with a vcn

Syntax

FUNCTION get_vcn_dns_resolver_association (
  vcn_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_vcn_dns_resolver_association_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VCN_TOPOLOGY Function

Gets a virtual network topology for a given VCN.

Syntax

FUNCTION get_vcn_topology (
  compartment_id varchar2,
  vcn_id varchar2,
  access_level varchar2 DEFAULT NULL,
  query_compartment_subtree number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  if_none_match varchar2 DEFAULT NULL,
  cache_control varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_vcn_topology_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`vcn_id`	(required) The OCID of the VCN.
`access_level`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_none_match`	(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`	(optional) The Cache-Control HTTP header holds directives (instructions) for caching in both requests and responses.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VIRTUAL_CIRCUIT Function

Gets the specified virtual circuit's information.

Syntax

FUNCTION get_virtual_circuit (
  virtual_circuit_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_virtual_circuit_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VLAN Function

Gets the specified VLAN's information.

Syntax

FUNCTION get_vlan (
  vlan_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_vlan_response_t;

Parameters

Parameter	Description
`vlan_id`	(required) The OCID of the VLAN.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VNIC Function

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

Syntax

FUNCTION get_vnic (
  vnic_id varchar2,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_vnic_response_t;

Parameters

Parameter	Description
`vnic_id`	(required) The OCID of the VNIC.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_VTAP Function

Gets the specified `Vtap` resource.

Syntax

FUNCTION get_vtap (
  vtap_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_get_vtap_response_t;

Parameters

Parameter	Description
`vtap_id`	(required) The OCID of the VTAP.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ALLOWED_PEER_REGIONS_FOR_REMOTE_PEERING Function

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

Syntax

FUNCTION list_allowed_peer_regions_for_remote_peering (
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_allowed_peer_regions_for_remote_peering_response_t;

Parameters

Parameter	Description
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BYOIP_ALLOCATED_RANGES Function

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.

Syntax

FUNCTION list_byoip_allocated_ranges (
  byoip_range_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_byoip_allocated_ranges_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_BYOIP_RANGES Function

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

Syntax

FUNCTION list_byoip_ranges (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_byoip_ranges_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`lifecycle_state`	(optional) A filter to return only resources that match the given lifecycle state name exactly.
`sort_by`	(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`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CAPTURE_FILTERS Function

Lists the capture filters in the specified compartment.

Syntax

FUNCTION list_capture_filters (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  filter_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_capture_filters_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`sort_by`	(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`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`lifecycle_state`	(optional) A filter to return only resources that match the given capture filter lifecycle state. The state value is case-insensitive.
`filter_type`	(optional) A filter to only return resources that match the given capture `filterType`. The `filterType` value is the string representation of enum - `VTAP`, `FLOWLOG`.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CPE_DEVICE_SHAPES Function

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 Type object. If you want to generate CPE configuration content for one of the returned CPE device types, ensure that the CPE Type 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: * GET_CPE_DEVICE_CONFIG_CONTENT Function * GET_IPSEC_CPE_DEVICE_CONFIG_CONTENT Function * GET_TUNNEL_CPE_DEVICE_CONFIG_CONTENT Function

Syntax

FUNCTION list_cpe_device_shapes (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_cpe_device_shapes_response_t;

Parameters

Parameter	Description
`limit`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CPES Function

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

Syntax

FUNCTION list_cpes (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_cpes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CROSS_CONNECT_GROUPS Function

Lists the cross-connect groups in the specified compartment.

Syntax

FUNCTION list_cross_connect_groups (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_cross_connect_groups_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CROSS_CONNECT_LOCATIONS Function

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.

Syntax

FUNCTION list_cross_connect_locations (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_cross_connect_locations_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CROSS_CONNECT_MAPPINGS Function

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

Syntax

FUNCTION list_cross_connect_mappings (
  virtual_circuit_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_cross_connect_mappings_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CROSS_CONNECTS Function

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

Syntax

FUNCTION list_cross_connects (
  compartment_id varchar2,
  cross_connect_group_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_cross_connects_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`cross_connect_group_id`	(optional) The OCID of the cross-connect group.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_CROSSCONNECT_PORT_SPEED_SHAPES Function

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.

Syntax

FUNCTION list_crossconnect_port_speed_shapes (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_crossconnect_port_speed_shapes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DHCP_OPTIONS Function

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.

Syntax

FUNCTION list_dhcp_options (
  compartment_id varchar2,
  vcn_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_dhcp_options_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`vcn_id`	(optional) The OCID of the VCN.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DRG_ATTACHMENTS Function

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.

Syntax

FUNCTION list_drg_attachments (
  compartment_id varchar2,
  vcn_id varchar2 DEFAULT NULL,
  drg_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  network_id varchar2 DEFAULT NULL,
  attachment_type varchar2 DEFAULT NULL,
  drg_route_table_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_drg_attachments_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`vcn_id`	(optional) The OCID of the VCN.
`drg_id`	(optional) The OCID of the DRG.
`limit`	(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`	(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`	(optional) The OCID of the resource (virtual circuit, VCN, IPSec tunnel, or remote peering connection) attached to the DRG.
`attachment_type`	(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`	(optional) The OCID of the DRG route table assigned to the DRG attachment.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DRG_ROUTE_DISTRIBUTION_STATEMENTS Function

Lists the statements for the specified route distribution.

Syntax

FUNCTION list_drg_route_distribution_statements (
  drg_route_distribution_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_drg_route_distribution_statements_response_t;

Parameters

Parameter	Description
`drg_route_distribution_id`	(required) The OCID of the route distribution.
`limit`	(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`	(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`	(optional) The field to sort by. Allowed values are: 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DRG_ROUTE_DISTRIBUTIONS Function

Lists the route distributions in the specified DRG. To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation.

Syntax

FUNCTION list_drg_route_distributions (
  drg_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_drg_route_distributions_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter that only returns resources that match the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DRG_ROUTE_RULES Function

Lists the route rules in the specified DRG route table.

Syntax

FUNCTION list_drg_route_rules (
  drg_route_table_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  route_type varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_drg_route_rules_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`limit`	(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`	(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`	(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'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DRG_ROUTE_TABLES Function

Lists the DRG route tables for the specified DRG. Use the `ListDrgRouteRules` operation to retrieve the route rules in a table.

Syntax

FUNCTION list_drg_route_tables (
  drg_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  import_drg_route_distribution_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_drg_route_tables_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) The OCID of the import route distribution.
`lifecycle_state`	(optional) A filter that only returns matches for the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_DRGS Function

Lists the DRGs in the specified compartment.

Syntax

FUNCTION list_drgs (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_drgs_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_FAST_CONNECT_PROVIDER_SERVICES Function

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.

Syntax

FUNCTION list_fast_connect_provider_services (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_fast_connect_provider_services_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_FAST_CONNECT_PROVIDER_VIRTUAL_CIRCUIT_BANDWIDTH_SHAPES Function

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.

Syntax

FUNCTION list_fast_connect_provider_virtual_circuit_bandwidth_shapes (
  provider_service_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_fast_connect_provider_virtual_circuit_bandwidth_shapes_response_t;

Parameters

Parameter	Description
`provider_service_id`	(required) The OCID of the provider service.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IP_SEC_CONNECTION_TUNNEL_ROUTES Function

The routes advertised to the on-premises network and the routes received from the on-premises network.

Syntax

FUNCTION list_ip_sec_connection_tunnel_routes (
  ipsc_id varchar2,
  tunnel_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  advertiser varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_ip_sec_connection_tunnel_routes_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`limit`	(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`	(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.
`advertiser`	(optional) Specifies the advertiser of the routes. If set to `ORACLE`, this returns only the routes advertised by Oracle. When set to `CUSTOMER`, this returns only the routes advertised by the CPE.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IP_SEC_CONNECTION_TUNNEL_SECURITY_ASSOCIATIONS Function

Lists the tunnel security associations information for the specified IPSec tunnel ID.

Syntax

FUNCTION list_ip_sec_connection_tunnel_security_associations (
  ipsc_id varchar2,
  tunnel_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_ip_sec_connection_tunnel_security_associations_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IP_SEC_CONNECTION_TUNNELS Function

Lists the tunnel information for the specified IPSec connection.

Syntax

FUNCTION list_ip_sec_connection_tunnels (
  ipsc_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_ip_sec_connection_tunnels_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IP_SEC_CONNECTIONS Function

Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.

Syntax

FUNCTION list_ip_sec_connections (
  compartment_id varchar2,
  drg_id varchar2 DEFAULT NULL,
  cpe_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_ip_sec_connections_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`drg_id`	(optional) The OCID of the DRG.
`cpe_id`	(optional) The OCID of the CPE.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_INTERNET_GATEWAYS Function

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.

Syntax

FUNCTION list_internet_gateways (
  compartment_id varchar2,
  vcn_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_internet_gateways_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`vcn_id`	(optional) The OCID of the VCN.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_IPV6S Function

Lists the IPV6 Type 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 Function requires the OCID.

Syntax

FUNCTION list_ipv6s (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  ip_address varchar2 DEFAULT NULL,
  subnet_id varchar2 DEFAULT NULL,
  vnic_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_ipv6s_response_t;

Parameters

Parameter	Description
`limit`	(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`	(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`	(optional) An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: `10.0.3.3`
`subnet_id`	(optional) The OCID of the subnet.
`vnic_id`	(optional) The OCID of the VNIC.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_LOCAL_PEERING_GATEWAYS Function

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.

Syntax

FUNCTION list_local_peering_gateways (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_local_peering_gateways_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) The OCID of the VCN.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NAT_GATEWAYS Function

Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

Syntax

FUNCTION list_nat_gateways (
  compartment_id varchar2,
  vcn_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_nat_gateways_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`vcn_id`	(optional) The OCID of the VCN.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NETWORK_SECURITY_GROUP_SECURITY_RULES Function

Lists the security rules in the specified network security group.

Syntax

FUNCTION list_network_security_group_security_rules (
  network_security_group_id varchar2,
  direction varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_network_security_group_security_rules_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`direction`	(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`	(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`	(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`	(optional) The field to sort by. Allowed values are: 'TIMECREATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NETWORK_SECURITY_GROUP_VNICS Function

Lists the VNICs in the specified network security group.

Syntax

FUNCTION list_network_security_group_vnics (
  network_security_group_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_network_security_group_vnics_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`limit`	(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`	(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`	(optional) The field to sort by. Allowed values are: 'TIMEASSOCIATED'
`sort_order`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_NETWORK_SECURITY_GROUPS Function

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.

Syntax

FUNCTION list_network_security_groups (
  compartment_id varchar2 DEFAULT NULL,
  vlan_id varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_network_security_groups_response_t;

Parameters

Parameter	Description
`compartment_id`	(optional) The OCID of the compartment.
`vlan_id`	(optional) The OCID of the VLAN.
`vcn_id`	(optional) The OCID of the VCN.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PRIVATE_IPS Function

Lists the PRIVATE_IP Type 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 Function 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 Type.

Syntax

FUNCTION list_private_ips (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  ip_address varchar2 DEFAULT NULL,
  subnet_id varchar2 DEFAULT NULL,
  vnic_id varchar2 DEFAULT NULL,
  vlan_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_private_ips_response_t;

Parameters

Parameter	Description
`limit`	(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`	(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`	(optional) An IP address. This could be either IPv4 or IPv6, depending on the resource. Example: `10.0.3.3`
`subnet_id`	(optional) The OCID of the subnet.
`vnic_id`	(optional) The OCID of the VNIC.
`vlan_id`	(optional) The OCID of the VLAN.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PUBLIC_IP_POOLS Function

Lists the public IP pools in the specified compartment. You can filter the list using query parameters.

Syntax

FUNCTION list_public_ip_pools (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  byoip_range_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_public_ip_pools_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`byoip_range_id`	(optional) A filter to return only resources that match the given BYOIP CIDR block.
`sort_by`	(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`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_PUBLIC_IPS Function

Lists the PUBLIC_IP Type 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.

Syntax

FUNCTION list_public_ips (
  scope varchar2,
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  availability_domain varchar2 DEFAULT NULL,
  lifetime varchar2 DEFAULT NULL,
  public_ip_pool_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_public_ips_response_t;

Parameters

Parameter	Description
`scope`	(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 `NAT_GATEWAY` Type), 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`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) The name of the availability domain. Example: `Uocm:PHX-AD-1`
`lifetime`	(optional) A filter to return only public IPs that match given lifetime. Allowed values are: 'EPHEMERAL', 'RESERVED'
`public_ip_pool_id`	(optional) A filter to return only resources that belong to the given public IP pool.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_REMOTE_PEERING_CONNECTIONS Function

Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC's compartment).

Syntax

FUNCTION list_remote_peering_connections (
  compartment_id varchar2,
  drg_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_remote_peering_connections_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`drg_id`	(optional) The OCID of the DRG.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_ROUTE_TABLES Function

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.

Syntax

FUNCTION list_route_tables (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_route_tables_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) The OCID of the VCN.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SECURITY_LISTS Function

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.

Syntax

FUNCTION list_security_lists (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_security_lists_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) The OCID of the VCN.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SERVICE_GATEWAYS Function

Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.

Syntax

FUNCTION list_service_gateways (
  compartment_id varchar2,
  vcn_id varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_service_gateways_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`vcn_id`	(optional) The OCID of the VCN.
`limit`	(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`	(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`	(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`	(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`	(optional) A filter to return only resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SERVICES Function

Lists the available SERVICE Type objects that you can enable for a service gateway in this region.

Syntax

FUNCTION list_services (
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_services_response_t;

Parameters

Parameter	Description
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_SUBNETS Function

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.

Syntax

FUNCTION list_subnets (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_subnets_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) The OCID of the VCN.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VCNS Function

Lists the virtual cloud networks (VCNs) in the specified compartment.

Syntax

FUNCTION list_vcns (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_vcns_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VIRTUAL_CIRCUIT_ASSOCIATED_TUNNELS Function

Gets the specified virtual circuit's associatedTunnelsInfo.

Syntax

FUNCTION list_virtual_circuit_associated_tunnels (
  virtual_circuit_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_virtual_circuit_associated_tunnels_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VIRTUAL_CIRCUIT_BANDWIDTH_SHAPES Function

The deprecated operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the OCID of your tenancy (the root compartment).

Syntax

FUNCTION list_virtual_circuit_bandwidth_shapes (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_virtual_circuit_bandwidth_shapes_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function

Lists the public IP prefixes and their details for the specified public virtual circuit.

Syntax

FUNCTION list_virtual_circuit_public_prefixes (
  virtual_circuit_id varchar2,
  verification_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_virtual_circuit_public_prefixes_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`verification_state`	(optional) A filter to only return resources that match the given verification state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VIRTUAL_CIRCUITS Function

Lists the virtual circuits in the specified compartment.

Syntax

FUNCTION list_virtual_circuits (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_virtual_circuits_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) A filter to return only resources that match the specified lifecycle state. The value is case insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VLANS Function

Lists the VLANs in the specified VCN and the specified compartment.

Syntax

FUNCTION list_vlans (
  compartment_id varchar2,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  vcn_id varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_vlans_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`limit`	(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`	(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`	(optional) The OCID of the VCN.
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`sort_by`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`lifecycle_state`	(optional) A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_VTAPS Function

Lists the virtual test access points (VTAPs) in the specified compartment.

Syntax

FUNCTION list_vtaps (
  compartment_id varchar2,
  vcn_id varchar2 DEFAULT NULL,
  source varchar2 DEFAULT NULL,
  target_id varchar2 DEFAULT NULL,
  target_ip varchar2 DEFAULT NULL,
  is_vtap_enabled number DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  display_name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_list_vtaps_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The OCID of the compartment.
`vcn_id`	(optional) The OCID of the VCN.
`source`	(optional) The OCID of the VTAP source.
`target_id`	(optional) The OCID of the VTAP target.
`target_ip`	(optional) The IP address of the VTAP target.
`is_vtap_enabled`	(optional) Indicates whether to list all VTAPs or only running VTAPs. * When `FALSE`, lists ALL running and stopped VTAPs. * When `TRUE`, lists only running VTAPs (VTAPs where isVtapEnabled = `TRUE`).
`limit`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`sort_by`	(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`	(optional) The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive. Allowed values are: 'ASC', 'DESC'
`display_name`	(optional) A filter to return only resources that match the given display name exactly.
`lifecycle_state`	(optional) A filter to return only resources that match the given VTAP administrative lifecycle state. The state value is case-insensitive.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

MODIFY_VCN_CIDR Function

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.

Syntax

FUNCTION modify_vcn_cidr (
  vcn_id varchar2,
  modify_vcn_cidr_details dbms_cloud_oci_core_modify_vcn_cidr_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_modify_vcn_cidr_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`modify_vcn_cidr_details`	(required) Details object for updating a VCN CIDR.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_DRG_ROUTE_DISTRIBUTION_STATEMENTS Function

Removes one or more route distribution statements from the specified route distribution's map.

Syntax

FUNCTION remove_drg_route_distribution_statements (
  drg_route_distribution_id varchar2,
  remove_drg_route_distribution_statements_details dbms_cloud_oci_core_remove_drg_route_distribution_statements_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_drg_route_distribution_statements_response_t;

Parameters

Parameter	Description
`drg_route_distribution_id`	(required) The OCID of the route distribution.
`remove_drg_route_distribution_statements_details`	(required) Request with one or more route distribution statements to remove from the route distribution.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_DRG_ROUTE_RULES Function

Removes one or more route rules from the specified DRG route table.

Syntax

FUNCTION remove_drg_route_rules (
  drg_route_table_id varchar2,
  remove_drg_route_rules_details dbms_cloud_oci_core_remove_drg_route_rules_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_drg_route_rules_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`remove_drg_route_rules_details`	(required) Request to remove one or more route rules in the DRG route table.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_EXPORT_DRG_ROUTE_DISTRIBUTION Function

Removes the export route distribution from the DRG attachment so no routes are advertised to it.

Syntax

FUNCTION remove_export_drg_route_distribution (
  drg_attachment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_export_drg_route_distribution_response_t;

Parameters

Parameter	Description
`drg_attachment_id`	(required) The OCID of the DRG attachment.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_IMPORT_DRG_ROUTE_DISTRIBUTION Function

Removes the import route distribution from the DRG route table so no routes are imported into it.

Syntax

FUNCTION remove_import_drg_route_distribution (
  drg_route_table_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_import_drg_route_distribution_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_IPV6_SUBNET_CIDR Function

Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain.

Syntax

FUNCTION remove_ipv6_subnet_cidr (
  subnet_id varchar2,
  remove_subnet_ipv6_cidr_details dbms_cloud_oci_core_remove_subnet_ipv6_cidr_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_ipv6_subnet_cidr_response_t;

Parameters

Parameter	Description
`subnet_id`	(required) The OCID of the subnet.
`remove_subnet_ipv6_cidr_details`	(required) Details object for removing an IPv6 SUBNET prefix.
`opc_retry_token`	(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`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_IPV6_VCN_CIDR Function

Removing an existing IPv6 prefix from a VCN.

Syntax

FUNCTION remove_ipv6_vcn_cidr (
  vcn_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  remove_vcn_ipv6_cidr_details dbms_cloud_oci_core_remove_vcn_ipv6_cidr_details_t DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_ipv6_vcn_cidr_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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`	(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.
`remove_vcn_ipv6_cidr_details`	(optional) Details object for removing a VCN IPv6 prefix.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_NETWORK_SECURITY_GROUP_SECURITY_RULES Function

Removes one or more security rules from the specified network security group.

Syntax

FUNCTION remove_network_security_group_security_rules (
  network_security_group_id varchar2,
  remove_network_security_group_security_rules_details dbms_cloud_oci_core_remove_network_security_group_security_rules_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_network_security_group_security_rules_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`remove_network_security_group_security_rules_details`	(required) Request with one or more security rules associated with the network security group that will be removed.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_PUBLIC_IP_POOL_CAPACITY Function

Removes a CIDR block from the referenced public IP pool.

Syntax

FUNCTION remove_public_ip_pool_capacity (
  public_ip_pool_id varchar2,
  remove_public_ip_pool_capacity_details dbms_cloud_oci_core_remove_public_ip_pool_capacity_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_public_ip_pool_capacity_response_t;

Parameters

Parameter	Description
`public_ip_pool_id`	(required) The OCID of the public IP pool.
`remove_public_ip_pool_capacity_details`	(required) The CIDR block to remove from the IP pool.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

REMOVE_VCN_CIDR Function

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.

Syntax

FUNCTION remove_vcn_cidr (
  vcn_id varchar2,
  remove_vcn_cidr_details dbms_cloud_oci_core_remove_vcn_cidr_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_remove_vcn_cidr_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`remove_vcn_cidr_details`	(required) Details object for removing a VCN CIDR.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_BYOIP_RANGE Function

Updates the tags or display name associated to the specified BYOIP CIDR block.

Syntax

FUNCTION update_byoip_range (
  byoip_range_id varchar2,
  update_byoip_range_details dbms_cloud_oci_core_update_byoip_range_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_byoip_range_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`update_byoip_range_details`	(required) Byoip Range details.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CAPTURE_FILTER Function

Updates the specified VTAP capture filter's display name or tags.

Syntax

FUNCTION update_capture_filter (
  capture_filter_id varchar2,
  update_capture_filter_details dbms_cloud_oci_core_update_capture_filter_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_capture_filter_response_t;

Parameters

Parameter	Description
`capture_filter_id`	(required) The OCID of the capture filter.
`update_capture_filter_details`	(required) Details object for updating a VTAP.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CPE Function

Updates the specified CPE's display name or tags. Avoid entering confidential information.

Syntax

FUNCTION update_cpe (
  cpe_id varchar2,
  update_cpe_details dbms_cloud_oci_core_update_cpe_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_cpe_response_t;

Parameters

Parameter	Description
`cpe_id`	(required) The OCID of the CPE.
`update_cpe_details`	(required) Details object for updating a CPE.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CROSS_CONNECT Function

Updates the specified cross-connect.

Syntax

FUNCTION update_cross_connect (
  cross_connect_id varchar2,
  update_cross_connect_details dbms_cloud_oci_core_update_cross_connect_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_cross_connect_response_t;

Parameters

Parameter	Description
`cross_connect_id`	(required) The OCID of the cross-connect.
`update_cross_connect_details`	(required) Update CrossConnect fields.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_CROSS_CONNECT_GROUP Function

Updates the specified cross-connect group's display name. Avoid entering confidential information.

Syntax

FUNCTION update_cross_connect_group (
  cross_connect_group_id varchar2,
  update_cross_connect_group_details dbms_cloud_oci_core_update_cross_connect_group_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_cross_connect_group_response_t;

Parameters

Parameter	Description
`cross_connect_group_id`	(required) The OCID of the cross-connect group.
`update_cross_connect_group_details`	(required) Update CrossConnectGroup fields
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DHCP_OPTIONS Function

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.

Syntax

FUNCTION update_dhcp_options (
  dhcp_id varchar2,
  update_dhcp_details dbms_cloud_oci_core_update_dhcp_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_dhcp_options_response_t;

Parameters

Parameter	Description
`dhcp_id`	(required) The OCID for the set of DHCP options.
`update_dhcp_details`	(required) Request object for updating a set of DHCP options.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DRG Function

Updates the specified DRG's display name or tags. Avoid entering confidential information.

Syntax

FUNCTION update_drg (
  drg_id varchar2,
  update_drg_details dbms_cloud_oci_core_update_drg_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_drg_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`update_drg_details`	(required) Details object for updating a DRG.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DRG_ATTACHMENT Function

Updates the display name and routing information for the specified `DrgAttachment`. Avoid entering confidential information.

Syntax

FUNCTION update_drg_attachment (
  drg_attachment_id varchar2,
  update_drg_attachment_details dbms_cloud_oci_core_update_drg_attachment_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_drg_attachment_response_t;

Parameters

Parameter	Description
`drg_attachment_id`	(required) The OCID of the DRG attachment.
`update_drg_attachment_details`	(required) Details object for updating a `DrgAttachment`.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DRG_ROUTE_DISTRIBUTION Function

Updates the specified route distribution

Syntax

FUNCTION update_drg_route_distribution (
  drg_route_distribution_id varchar2,
  update_drg_route_distribution_details dbms_cloud_oci_core_update_drg_route_distribution_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_drg_route_distribution_response_t;

Parameters

Parameter	Description
`drg_route_distribution_id`	(required) The OCID of the route distribution.
`update_drg_route_distribution_details`	(required) Details object for updating a route distribution
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DRG_ROUTE_DISTRIBUTION_STATEMENTS Function

Updates one or more route distribution statements in the specified route distribution.

Syntax

FUNCTION update_drg_route_distribution_statements (
  drg_route_distribution_id varchar2,
  update_drg_route_distribution_statements_details dbms_cloud_oci_core_update_drg_route_distribution_statements_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_drg_route_distribution_statements_response_t;

Parameters

Parameter	Description
`drg_route_distribution_id`	(required) The OCID of the route distribution.
`update_drg_route_distribution_statements_details`	(required) Request to update one or more route distribution statements in the route distribution.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DRG_ROUTE_RULES Function

Updates one or more route rules in the specified DRG route table.

Syntax

FUNCTION update_drg_route_rules (
  drg_route_table_id varchar2,
  update_drg_route_rules_details dbms_cloud_oci_core_update_drg_route_rules_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_drg_route_rules_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`update_drg_route_rules_details`	(required) Request to update one or more route rules in the DRG route table.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_DRG_ROUTE_TABLE Function

Updates the specified DRG route table.

Syntax

FUNCTION update_drg_route_table (
  drg_route_table_id varchar2,
  update_drg_route_table_details dbms_cloud_oci_core_update_drg_route_table_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_drg_route_table_response_t;

Parameters

Parameter	Description
`drg_route_table_id`	(required) The OCID of the DRG route table.
`update_drg_route_table_details`	(required) Details object used to updating a DRG route table.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_IP_SEC_CONNECTION Function

Updates the specified IPSec connection. To update an individual IPSec tunnel's attributes, use UPDATE_IP_SEC_CONNECTION_TUNNEL Function.

Syntax

FUNCTION update_ip_sec_connection (
  ipsc_id varchar2,
  update_ip_sec_connection_details dbms_cloud_oci_core_update_ip_sec_connection_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_ip_sec_connection_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`update_ip_sec_connection_details`	(required) Details object for updating an IPSec connection.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_IP_SEC_CONNECTION_TUNNEL Function

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 Function). * If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the IP_SEC_CONNECTION Type already has at least one valid CIDR static route.

Syntax

FUNCTION update_ip_sec_connection_tunnel (
  ipsc_id varchar2,
  tunnel_id varchar2,
  update_ip_sec_connection_tunnel_details dbms_cloud_oci_core_update_ip_sec_connection_tunnel_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_ip_sec_connection_tunnel_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`update_ip_sec_connection_tunnel_details`	(required) Details object for updating a IPSecConnection tunnel's details.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_IP_SEC_CONNECTION_TUNNEL_SHARED_SECRET Function

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.

Syntax

FUNCTION update_ip_sec_connection_tunnel_shared_secret (
  ipsc_id varchar2,
  tunnel_id varchar2,
  update_ip_sec_connection_tunnel_shared_secret_details dbms_cloud_oci_core_update_ip_sec_connection_tunnel_shared_secret_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_ip_sec_connection_tunnel_shared_secret_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`update_ip_sec_connection_tunnel_shared_secret_details`	(required) Details object for updating a IPSec connection tunnel's sharedSecret.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_INTERNET_GATEWAY Function

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.

Syntax

FUNCTION update_internet_gateway (
  ig_id varchar2,
  update_internet_gateway_details dbms_cloud_oci_core_update_internet_gateway_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_internet_gateway_response_t;

Parameters

Parameter	Description
`ig_id`	(required) The OCID of the internet gateway.
`update_internet_gateway_details`	(required) Details for updating the internet gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_IPV6 Function

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.

Syntax

FUNCTION update_ipv6 (
  ipv6_id varchar2,
  update_ipv6_details dbms_cloud_oci_core_update_ipv6_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_ipv6_response_t;

Parameters

Parameter	Description
`ipv6_id`	(required) The OCID of the IPv6.
`update_ipv6_details`	(required) IPv6 details to be updated.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_LOCAL_PEERING_GATEWAY Function

Updates the specified local peering gateway (LPG).

Syntax

FUNCTION update_local_peering_gateway (
  local_peering_gateway_id varchar2,
  update_local_peering_gateway_details dbms_cloud_oci_core_update_local_peering_gateway_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_local_peering_gateway_response_t;

Parameters

Parameter	Description
`local_peering_gateway_id`	(required) The OCID of the local peering gateway.
`update_local_peering_gateway_details`	(required) Details object for updating a local peering gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_NAT_GATEWAY Function

Updates the specified NAT gateway.

Syntax

FUNCTION update_nat_gateway (
  nat_gateway_id varchar2,
  update_nat_gateway_details dbms_cloud_oci_core_update_nat_gateway_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_nat_gateway_response_t;

Parameters

Parameter	Description
`nat_gateway_id`	(required) The NAT gateway's OCID.
`update_nat_gateway_details`	(required) Details object for updating a NAT gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_NETWORK_SECURITY_GROUP Function

Updates the specified network security group. To add or remove an existing VNIC from the group, use UPDATE_VNIC Function. 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 Function. To add or remove security rules from the group, use ADD_NETWORK_SECURITY_GROUP_SECURITY_RULES Function or REMOVE_NETWORK_SECURITY_GROUP_SECURITY_RULES Function. To edit the contents of existing security rules in the group, use UPDATE_NETWORK_SECURITY_GROUP_SECURITY_RULES Function.

Syntax

FUNCTION update_network_security_group (
  network_security_group_id varchar2,
  update_network_security_group_details dbms_cloud_oci_core_update_network_security_group_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_network_security_group_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`update_network_security_group_details`	(required) Details object for updating a network security group.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_NETWORK_SECURITY_GROUP_SECURITY_RULES Function

Updates one or more security rules in the specified network security group.

Syntax

FUNCTION update_network_security_group_security_rules (
  network_security_group_id varchar2,
  update_network_security_group_security_rules_details dbms_cloud_oci_core_update_network_security_group_security_rules_details_t,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_network_security_group_security_rules_response_t;

Parameters

Parameter	Description
`network_security_group_id`	(required) The OCID of the network security group.
`update_network_security_group_security_rules_details`	(required) Request with one or more security rules associated with the network security group that will be updated.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PRIVATE_IP Function

Updates the specified private IP. You must specify the object's OCID. Use this operation if you want to: - Move a secondary private IP to a different VNIC in the same subnet. - Change the display name for a secondary private IP. - Change the hostname for a secondary private IP. This operation cannot be used with primary private IPs. To update the hostname for the primary IP on a VNIC, use UPDATE_VNIC Function.

Syntax

FUNCTION update_private_ip (
  private_ip_id varchar2,
  update_private_ip_details dbms_cloud_oci_core_update_private_ip_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_private_ip_response_t;

Parameters

Parameter	Description
`private_ip_id`	(required) The OCID of the private IP or IPv6.
`update_private_ip_details`	(required) Private IP details.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PUBLIC_IP Function

Updates the specified public IP. You must specify the object's OCID. Use this operation if you want to: * Assign a reserved public IP in your pool to a private IP. * Move a reserved public IP to a different private IP. * Unassign a reserved public IP from a private IP (which returns it to your pool of reserved public IPs). * Change the display name or tags for a public IP. Assigning, moving, and unassigning a reserved public IP are asynchronous operations. Poll the public IP's `lifecycleState` to determine if the operation succeeded. **Note:** When moving a reserved public IP, the target private IP must not already have a public IP with `lifecycleState` = ASSIGNING or ASSIGNED. If it does, an error is returned. Also, the initial unassignment from the original private IP always succeeds, but the assignment to the target private IP is asynchronous and could fail silently (for example, if the target private IP is deleted or has a different public IP assigned to it in the interim). If that occurs, the public IP remains unassigned and its `lifecycleState` switches to AVAILABLE (it is not reassigned to its original private IP). You must poll the public IP's `lifecycleState` to determine if the move succeeded. Regarding ephemeral public IPs: * If you want to assign an ephemeral public IP to a primary private IP, use CREATE_PUBLIC_IP Function. * You can't move an ephemeral public IP to a different private IP. * If you want to unassign an ephemeral public IP from its private IP, use DELETE_PUBLIC_IP Function, which unassigns and deletes the ephemeral public IP. **Note:** If a public IP is assigned to a secondary private IP (see PRIVATE_IP Type), and you move that secondary private IP to another VNIC, the public IP moves with it. **Note:** There's a limit to the number of PUBLIC_IP Type a VNIC or instance can have. If you try to move a reserved public IP to a VNIC or instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see Public IP Addresses.

Syntax

FUNCTION update_public_ip (
  public_ip_id varchar2,
  update_public_ip_details dbms_cloud_oci_core_update_public_ip_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_public_ip_response_t;

Parameters

Parameter	Description
`public_ip_id`	(required) The OCID of the public IP.
`update_public_ip_details`	(required) Public IP details.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_PUBLIC_IP_POOL Function

Updates the specified public IP pool.

Syntax

FUNCTION update_public_ip_pool (
  public_ip_pool_id varchar2,
  update_public_ip_pool_details dbms_cloud_oci_core_update_public_ip_pool_details_t,
  opc_request_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_public_ip_pool_response_t;

Parameters

Parameter	Description
`public_ip_pool_id`	(required) The OCID of the public IP pool.
`update_public_ip_pool_details`	(required) Public IP pool details.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_REMOTE_PEERING_CONNECTION Function

Updates the specified remote peering connection (RPC).

Syntax

FUNCTION update_remote_peering_connection (
  remote_peering_connection_id varchar2,
  update_remote_peering_connection_details dbms_cloud_oci_core_update_remote_peering_connection_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_remote_peering_connection_response_t;

Parameters

Parameter	Description
`remote_peering_connection_id`	(required) The OCID of the remote peering connection (RPC).
`update_remote_peering_connection_details`	(required) Request to the update the peering connection to remote region
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ROUTE_TABLE Function

Updates the specified route table's display name or route rules. Avoid entering confidential information. Note that the `routeRules` object you provide replaces the entire existing set of rules.

Syntax

FUNCTION update_route_table (
  rt_id varchar2,
  update_route_table_details dbms_cloud_oci_core_update_route_table_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_route_table_response_t;

Parameters

Parameter	Description
`rt_id`	(required) The OCID of the route table.
`update_route_table_details`	(required) Details object for updating a route table.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SECURITY_LIST Function

Updates the specified security list's display name or rules. Avoid entering confidential information. Note that the `egressSecurityRules` or `ingressSecurityRules` objects you provide replace the entire existing objects.

Syntax

FUNCTION update_security_list (
  security_list_id varchar2,
  update_security_list_details dbms_cloud_oci_core_update_security_list_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_security_list_response_t;

Parameters

Parameter	Description
`security_list_id`	(required) The OCID of the security list.
`update_security_list_details`	(required) Updated details for the security list.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SERVICE_GATEWAY Function

Updates the specified service gateway. The information you provide overwrites the existing attributes of the gateway.

Syntax

FUNCTION update_service_gateway (
  service_gateway_id varchar2,
  update_service_gateway_details dbms_cloud_oci_core_update_service_gateway_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_service_gateway_response_t;

Parameters

Parameter	Description
`service_gateway_id`	(required) The service gateway's OCID.
`update_service_gateway_details`	(required) Details object for updating a service gateway.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_SUBNET Function

Updates the specified subnet.

Syntax

FUNCTION update_subnet (
  subnet_id varchar2,
  update_subnet_details dbms_cloud_oci_core_update_subnet_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_subnet_response_t;

Parameters

Parameter	Description
`subnet_id`	(required) The OCID of the subnet.
`update_subnet_details`	(required) Details object for updating a subnet.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TUNNEL_CPE_DEVICE_CONFIG Function

Creates or updates the set of CPE configuration answers for the specified tunnel. The answers correlate to the questions that are specific to the CPE device type (see the `parameters` attribute of CPE_DEVICE_SHAPE_DETAIL Type).

Syntax

FUNCTION update_tunnel_cpe_device_config (
  ipsc_id varchar2,
  tunnel_id varchar2,
  update_tunnel_cpe_device_config_details dbms_cloud_oci_core_update_tunnel_cpe_device_config_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_tunnel_cpe_device_config_response_t;

Parameters

Parameter	Description
`ipsc_id`	(required) The OCID of the IPSec connection.
`tunnel_id`	(required) The OCID of the tunnel.
`update_tunnel_cpe_device_config_details`	(required) Request to input the tunnel's cpe configuration parameters
`if_match`	(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_retry_token`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VCN Function

Updates the specified VCN.

Syntax

FUNCTION update_vcn (
  vcn_id varchar2,
  update_vcn_details dbms_cloud_oci_core_update_vcn_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_vcn_response_t;

Parameters

Parameter	Description
`vcn_id`	(required) The OCID of the VCN.
`update_vcn_details`	(required) Details object for updating a VCN.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VIRTUAL_CIRCUIT Function

Updates the specified virtual circuit. This can be called by either the customer who owns the virtual circuit, or the provider (when provisioning or de-provisioning the virtual circuit from their end). The documentation for UPDATE_VIRTUAL_CIRCUIT_DETAILS Function indicates who can update each property of the virtual circuit. **Important:** If the virtual circuit is working and in the PROVISIONED state, updating any of the network-related properties (such as the DRG being used, the BGP ASN, and so on) will cause the virtual circuit's state to switch to PROVISIONING and the related BGP session to go down. After Oracle re-provisions the virtual circuit, its state will return to PROVISIONED. Make sure you confirm that the associated BGP session is back up. For more information about the various states and how to test connectivity, see FastConnect Overview. To change the list of public IP prefixes for a public virtual circuit, use BULK_ADD_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function and BULK_DELETE_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function. Updating the list of prefixes does NOT cause the BGP session to go down. However, Oracle must verify the customer's ownership of each added prefix before traffic for that prefix will flow across the virtual circuit.

Syntax

FUNCTION update_virtual_circuit (
  virtual_circuit_id varchar2,
  update_virtual_circuit_details dbms_cloud_oci_core_update_virtual_circuit_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_virtual_circuit_response_t;

Parameters

Parameter	Description
`virtual_circuit_id`	(required) The OCID of the virtual circuit.
`update_virtual_circuit_details`	(required) Update VirtualCircuit fields.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VLAN Function

Updates the specified VLAN. Note that this operation might require changes to all the VNICs in the VLAN, which can take a while. The VLAN will be in the UPDATING state until the changes are complete.

Syntax

FUNCTION update_vlan (
  vlan_id varchar2,
  update_vlan_details dbms_cloud_oci_core_update_vlan_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_vlan_response_t;

Parameters

Parameter	Description
`vlan_id`	(required) The OCID of the VLAN.
`update_vlan_details`	(required) Details object for updating a subnet.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VNIC Function

Updates the specified VNIC.

Syntax

FUNCTION update_vnic (
  vnic_id varchar2,
  update_vnic_details dbms_cloud_oci_core_update_vnic_details_t,
  if_match varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_vnic_response_t;

Parameters

Parameter	Description
`vnic_id`	(required) The OCID of the VNIC.
`update_vnic_details`	(required) Details object for updating a VNIC.
`if_match`	(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.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_VTAP Function

Updates the specified VTAP's display name or tags.

Syntax

FUNCTION update_vtap (
  vtap_id varchar2,
  update_vtap_details dbms_cloud_oci_core_update_vtap_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_update_vtap_response_t;

Parameters

Parameter	Description
`vtap_id`	(required) The OCID of the VTAP.
`update_vtap_details`	(required) Details object for updating a VTAP.
`if_match`	(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`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPGRADE_DRG Function

Upgrades the DRG. After upgrade, you can control routing inside your DRG via DRG attachments, route distributions, and DRG route tables.

Syntax

FUNCTION upgrade_drg (
  drg_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  opc_retry_token varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_upgrade_drg_response_t;

Parameters

Parameter	Description
`drg_id`	(required) The OCID of the DRG.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc_retry_token`	(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).
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

VALIDATE_BYOIP_RANGE Function

Submits the BYOIP CIDR block you are importing for validation. Do not submit to Oracle for validation if you have not already modified the information for the BYOIP CIDR block with your Regional Internet Registry. See To import a CIDR block for details.

Syntax

FUNCTION validate_byoip_range (
  byoip_range_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_validate_byoip_range_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

WITHDRAW_BYOIP_RANGE Function

Withdraws BGP route advertisement for the BYOIP CIDR block.

Syntax

FUNCTION withdraw_byoip_range (
  byoip_range_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_cr_virtual_network_withdraw_byoip_range_response_t;

Parameters

Parameter	Description
`byoip_range_id`	(required) The OCID of the `ByoipRange` resource containing the BYOIP CIDR block.
`opc_request_id`	(optional) Unique identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://iaas.{region}.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation Try Free Tier

ADD_DRG_ROUTE_DISTRIBUTION_STATEMENTS Function 🔗

ADD_DRG_ROUTE_RULES Function 🔗

ADD_IPV6_SUBNET_CIDR Function 🔗

ADD_IPV6_VCN_CIDR Function 🔗

ADD_NETWORK_SECURITY_GROUP_SECURITY_RULES Function 🔗

ADD_PUBLIC_IP_POOL_CAPACITY Function 🔗

ADD_VCN_CIDR Function 🔗

ADVERTISE_BYOIP_RANGE Function 🔗

ATTACH_SERVICE_ID Function 🔗

BULK_ADD_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function 🔗

BULK_DELETE_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function 🔗

CHANGE_BYOIP_RANGE_COMPARTMENT Function 🔗

CHANGE_CAPTURE_FILTER_COMPARTMENT Function 🔗

CHANGE_CPE_COMPARTMENT Function 🔗

CHANGE_CROSS_CONNECT_COMPARTMENT Function 🔗

CHANGE_CROSS_CONNECT_GROUP_COMPARTMENT Function 🔗

CHANGE_DHCP_OPTIONS_COMPARTMENT Function 🔗

CHANGE_DRG_COMPARTMENT Function 🔗

CHANGE_IP_SEC_CONNECTION_COMPARTMENT Function 🔗

CHANGE_INTERNET_GATEWAY_COMPARTMENT Function 🔗

CHANGE_LOCAL_PEERING_GATEWAY_COMPARTMENT Function 🔗

CHANGE_NAT_GATEWAY_COMPARTMENT Function 🔗

CHANGE_NETWORK_SECURITY_GROUP_COMPARTMENT Function 🔗

CHANGE_PUBLIC_IP_COMPARTMENT Function 🔗

CHANGE_PUBLIC_IP_POOL_COMPARTMENT Function 🔗

CHANGE_REMOTE_PEERING_CONNECTION_COMPARTMENT Function 🔗

CHANGE_ROUTE_TABLE_COMPARTMENT Function 🔗

CHANGE_SECURITY_LIST_COMPARTMENT Function 🔗

CHANGE_SERVICE_GATEWAY_COMPARTMENT Function 🔗

CHANGE_SUBNET_COMPARTMENT Function 🔗

CHANGE_VCN_COMPARTMENT Function 🔗

CHANGE_VIRTUAL_CIRCUIT_COMPARTMENT Function 🔗

CHANGE_VLAN_COMPARTMENT Function 🔗

CHANGE_VTAP_COMPARTMENT Function 🔗

CONNECT_LOCAL_PEERING_GATEWAYS Function 🔗

CONNECT_REMOTE_PEERING_CONNECTIONS Function 🔗

CREATE_BYOIP_RANGE Function 🔗

CREATE_CAPTURE_FILTER Function 🔗

CREATE_CPE Function 🔗

CREATE_CROSS_CONNECT Function 🔗

CREATE_CROSS_CONNECT_GROUP Function 🔗

CREATE_DHCP_OPTIONS Function 🔗

CREATE_DRG Function 🔗

CREATE_DRG_ATTACHMENT Function 🔗

CREATE_DRG_ROUTE_DISTRIBUTION Function 🔗

CREATE_DRG_ROUTE_TABLE Function 🔗

CREATE_IP_SEC_CONNECTION Function 🔗

CREATE_INTERNET_GATEWAY Function 🔗

CREATE_IPV6 Function 🔗

CREATE_LOCAL_PEERING_GATEWAY Function 🔗

CREATE_NAT_GATEWAY Function 🔗

CREATE_NETWORK_SECURITY_GROUP Function 🔗

CREATE_PRIVATE_IP Function 🔗

CREATE_PUBLIC_IP Function 🔗

CREATE_PUBLIC_IP_POOL Function 🔗

CREATE_REMOTE_PEERING_CONNECTION Function 🔗

CREATE_ROUTE_TABLE Function 🔗

CREATE_SECURITY_LIST Function 🔗

CREATE_SERVICE_GATEWAY Function 🔗

CREATE_SUBNET Function 🔗

CREATE_VCN Function 🔗

CREATE_VIRTUAL_CIRCUIT Function 🔗

CREATE_VLAN Function 🔗

CREATE_VTAP Function 🔗

DELETE_BYOIP_RANGE Function 🔗

DELETE_CAPTURE_FILTER Function 🔗

DELETE_CPE Function 🔗

DELETE_CROSS_CONNECT Function 🔗

DELETE_CROSS_CONNECT_GROUP Function 🔗

DELETE_DHCP_OPTIONS Function 🔗

DELETE_DRG Function 🔗

DELETE_DRG_ATTACHMENT Function 🔗

DELETE_DRG_ROUTE_DISTRIBUTION Function 🔗

DELETE_DRG_ROUTE_TABLE Function 🔗

DELETE_IP_SEC_CONNECTION Function 🔗

DELETE_INTERNET_GATEWAY Function 🔗

DELETE_IPV6 Function 🔗

DELETE_LOCAL_PEERING_GATEWAY Function 🔗

DELETE_NAT_GATEWAY Function 🔗

Oracle Cloud Infrastructure Documentation
Try Free Tier

ADD_DRG_ROUTE_DISTRIBUTION_STATEMENTS Function

ADD_DRG_ROUTE_RULES Function

ADD_IPV6_SUBNET_CIDR Function

ADD_IPV6_VCN_CIDR Function

ADD_NETWORK_SECURITY_GROUP_SECURITY_RULES Function

ADD_PUBLIC_IP_POOL_CAPACITY Function

ADD_VCN_CIDR Function

ADVERTISE_BYOIP_RANGE Function

ATTACH_SERVICE_ID Function

BULK_ADD_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function

BULK_DELETE_VIRTUAL_CIRCUIT_PUBLIC_PREFIXES Function

CHANGE_BYOIP_RANGE_COMPARTMENT Function

CHANGE_CAPTURE_FILTER_COMPARTMENT Function

CHANGE_CPE_COMPARTMENT Function

CHANGE_CROSS_CONNECT_COMPARTMENT Function

CHANGE_CROSS_CONNECT_GROUP_COMPARTMENT Function

CHANGE_DHCP_OPTIONS_COMPARTMENT Function

CHANGE_DRG_COMPARTMENT Function

CHANGE_IP_SEC_CONNECTION_COMPARTMENT Function

CHANGE_INTERNET_GATEWAY_COMPARTMENT Function

CHANGE_LOCAL_PEERING_GATEWAY_COMPARTMENT Function

CHANGE_NAT_GATEWAY_COMPARTMENT Function

CHANGE_NETWORK_SECURITY_GROUP_COMPARTMENT Function

CHANGE_PUBLIC_IP_COMPARTMENT Function

CHANGE_PUBLIC_IP_POOL_COMPARTMENT Function

CHANGE_REMOTE_PEERING_CONNECTION_COMPARTMENT Function

CHANGE_ROUTE_TABLE_COMPARTMENT Function

CHANGE_SECURITY_LIST_COMPARTMENT Function

CHANGE_SERVICE_GATEWAY_COMPARTMENT Function

CHANGE_SUBNET_COMPARTMENT Function

CHANGE_VCN_COMPARTMENT Function

CHANGE_VIRTUAL_CIRCUIT_COMPARTMENT Function

CHANGE_VLAN_COMPARTMENT Function

CHANGE_VTAP_COMPARTMENT Function

CONNECT_LOCAL_PEERING_GATEWAYS Function

CONNECT_REMOTE_PEERING_CONNECTIONS Function

CREATE_BYOIP_RANGE Function

CREATE_CAPTURE_FILTER Function

CREATE_CPE Function

CREATE_CROSS_CONNECT Function

CREATE_CROSS_CONNECT_GROUP Function

CREATE_DHCP_OPTIONS Function

CREATE_DRG Function

CREATE_DRG_ATTACHMENT Function

CREATE_DRG_ROUTE_DISTRIBUTION Function

CREATE_DRG_ROUTE_TABLE Function

CREATE_IP_SEC_CONNECTION Function

CREATE_INTERNET_GATEWAY Function

CREATE_IPV6 Function

CREATE_LOCAL_PEERING_GATEWAY Function

CREATE_NAT_GATEWAY Function

CREATE_NETWORK_SECURITY_GROUP Function

CREATE_PRIVATE_IP Function

CREATE_PUBLIC_IP Function

CREATE_PUBLIC_IP_POOL Function

CREATE_REMOTE_PEERING_CONNECTION Function

CREATE_ROUTE_TABLE Function

CREATE_SECURITY_LIST Function

CREATE_SERVICE_GATEWAY Function

CREATE_SUBNET Function

CREATE_VCN Function

CREATE_VIRTUAL_CIRCUIT Function

CREATE_VLAN Function

CREATE_VTAP Function

DELETE_BYOIP_RANGE Function

DELETE_CAPTURE_FILTER Function

DELETE_CPE Function

DELETE_CROSS_CONNECT Function

DELETE_CROSS_CONNECT_GROUP Function

DELETE_DHCP_OPTIONS Function

DELETE_DRG Function

DELETE_DRG_ATTACHMENT Function

DELETE_DRG_ROUTE_DISTRIBUTION Function

DELETE_DRG_ROUTE_TABLE Function

DELETE_IP_SEC_CONNECTION Function

DELETE_INTERNET_GATEWAY Function

DELETE_IPV6 Function

DELETE_LOCAL_PEERING_GATEWAY Function

DELETE_NAT_GATEWAY Function