Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VirtualNetworkClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • VirtualNetworkClient

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new VirtualNetworkClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): VirtualNetworkClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

targetService

targetService: string = "VirtualNetwork"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://iaas.{region}.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

addDrgRouteDistributionStatements

addDrgRouteRules

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddDrgRouteRules API.

    Parameters

    Returns Promise<AddDrgRouteRulesResponse>

    AddDrgRouteRulesResponse

addIpv6SubnetCidr

addIpv6VcnCidr

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddIpv6VcnCidr API.

    Parameters

    Returns Promise<AddIpv6VcnCidrResponse>

    AddIpv6VcnCidrResponse

addNetworkSecurityGroupSecurityRules

addPublicIpPoolCapacity

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddPublicIpPoolCapacity API.

    Parameters

    Returns Promise<AddPublicIpPoolCapacityResponse>

    AddPublicIpPoolCapacityResponse

addVcnCidr

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AddVcnCidr API.

    Parameters

    Returns Promise<AddVcnCidrResponse>

    AddVcnCidrResponse

advertiseByoipRange

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AdvertiseByoipRange API.

    Parameters

    Returns Promise<AdvertiseByoipRangeResponse>

    AdvertiseByoipRangeResponse

attachServiceId

  • Adds the specified Service to the list of enabled Service objects for the specified gateway. You must also set up a route rule with the cidrBlock of the Service as the rule's destination and the service gateway as the rule's target. See RouteTable.

    *Note:** The `AttachServiceId` operation is an easy way to add an individual `Service` to the service gateway. Compare it with {@link #updateServiceGateway(UpdateServiceGatewayRequest) updateServiceGateway}, which replaces the entire existing list of enabled `Service` objects with the list that you provide in the `Update` call.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use AttachServiceId API.

    Parameters

    Returns Promise<AttachServiceIdResponse>

    AttachServiceIdResponse

bulkAddVirtualCircuitPublicPrefixes

  • Adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not {@link #updateVirtualCircuit(UpdateVirtualCircuitRequest) updateVirtualCircuit}) 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkAddVirtualCircuitPublicPrefixes API.

    Parameters

    Returns Promise<BulkAddVirtualCircuitPublicPrefixesResponse>

    BulkAddVirtualCircuitPublicPrefixesResponse

bulkDeleteVirtualCircuitPublicPrefixes

  • Removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not {@link #updateVirtualCircuit(UpdateVirtualCircuitRequest) updateVirtualCircuit}) 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use BulkDeleteVirtualCircuitPublicPrefixes API.

    Parameters

    Returns Promise<BulkDeleteVirtualCircuitPublicPrefixesResponse>

    BulkDeleteVirtualCircuitPublicPrefixesResponse

changeByoipRangeCompartment

changeCaptureFilterCompartment

changeCpeCompartment

changeCrossConnectCompartment

changeCrossConnectGroupCompartment

changeDhcpOptionsCompartment

changeDrgCompartment

changeIPSecConnectionCompartment

changeInternetGatewayCompartment

changeLocalPeeringGatewayCompartment

changeNatGatewayCompartment

changeNetworkSecurityGroupCompartment

changePublicIpCompartment

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ChangePublicIpCompartment API.

    Parameters

    Returns Promise<ChangePublicIpCompartmentResponse>

    ChangePublicIpCompartmentResponse

changePublicIpPoolCompartment

changeRemotePeeringConnectionCompartment

changeRouteTableCompartment

changeSecurityListCompartment

changeServiceGatewayCompartment

changeSubnetCompartment

changeVcnCompartment

changeVirtualCircuitCompartment

changeVlanCompartment

changeVtapCompartment

close

  • close(): void

connectLocalPeeringGateways

  • 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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/VCNpeering.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ConnectLocalPeeringGateways API.

    Parameters

    Returns Promise<ConnectLocalPeeringGatewaysResponse>

    ConnectLocalPeeringGatewaysResponse

connectRemotePeeringConnections

  • 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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/VCNpeering.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ConnectRemotePeeringConnections API.

    Parameters

    Returns Promise<ConnectRemotePeeringConnectionsResponse>

    ConnectRemotePeeringConnectionsResponse

createByoipRange

createCaptureFilter

  • Creates a virtual test access point (VTAP) capture filter in the specified compartment.

    For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. For more information about compartments and access control, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCaptureFilter API.

    Parameters

    Returns Promise<CreateCaptureFilterResponse>

    CreateCaptureFilterResponse

createCpe

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    You must provide the public IP address of your on-premises router. See [CPE Configuration](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/configuringCPE.htm).

    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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCpe API.

    Parameters

    Returns Promise<CreateCpeResponse>

    CreateCpeResponse

createCrossConnect

  • Creates a new cross-connect. Oracle recommends you create each cross-connect in a CrossConnectGroup so you can use link aggregation with the connection.

    After creating the `CrossConnect` object, you need to go the FastConnect location and request to have the physical cable installed. For more information, see [FastConnect Overview](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).

    For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCrossConnect API.

    Parameters

    Returns Promise<CreateCrossConnectResponse>

    CreateCrossConnectResponse

createCrossConnectGroup

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateCrossConnectGroup API.

    Parameters

    Returns Promise<CreateCrossConnectGroupResponse>

    CreateCrossConnectGroupResponse

createDhcpOptions

  • Creates a new set of DHCP options for the specified VCN. For more information, see DhcpOptions.

    For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDhcpOptions API.

    Parameters

    Returns Promise<CreateDhcpOptionsResponse>

    CreateDhcpOptionsResponse

createDrg

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDrg API.

    Parameters

    Returns Promise<CreateDrgResponse>

    CreateDrgResponse

createDrgAttachment

  • 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDrgAttachment API.

    Parameters

    Returns Promise<CreateDrgAttachmentResponse>

    CreateDrgAttachmentResponse

createDrgRouteDistribution

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDrgRouteDistribution API.

    Parameters

    Returns Promise<CreateDrgRouteDistributionResponse>

    CreateDrgRouteDistributionResponse

createDrgRouteTable

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateDrgRouteTable API.

    Parameters

    Returns Promise<CreateDrgRouteTableResponse>

    CreateDrgRouteTableResponse

createIPSecConnection

  • Creates a new IPSec connection between the specified DRG and CPE. For more information, see Site-to-Site VPN Overview.

    If you configure at least one tunnel to use static routing, then in the request you must provide at least one valid static route (you're allowed a maximum of 10). For example: 10.0.0.0/16. If you configure both tunnels to use BGP dynamic routing, you can provide an empty list for the static routes. For more information, see the important note in IPSecConnection.

    For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

    You may optionally specify a *display name* for the IPSec connection, otherwise a default is provided. It does not have to be unique, and you can change it. Avoid entering confidential information.

    After creating the IPSec connection, you need to configure your on-premises router with tunnel-specific information. For tunnel status and the required configuration information, see:

    IPSecConnectionTunnel * IPSecConnectionTunnelSharedSecret

    For each tunnel, you need the IP address of Oracle's VPN headend and the shared secret (that is, the pre-shared key). For more information, see [CPE Configuration](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/configuringCPE.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateIPSecConnection API.

    Parameters

    Returns Promise<CreateIPSecConnectionResponse>

    CreateIPSecConnectionResponse

createInternetGateway

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm).

    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 {@link #updateRouteTable(UpdateRouteTableRequest) updateRouteTable}.

    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 {@link #updateInternetGateway(UpdateInternetGatewayRequest) updateInternetGateway} to easily disable/enable the gateway without changing the route rule.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateInternetGateway API.

    Parameters

    Returns Promise<CreateInternetGatewayResponse>

    CreateInternetGatewayResponse

createIpv6

  • Creates an IPv6 for the specified VNIC.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateIpv6 API.

    Parameters

    Returns Promise<CreateIpv6Response>

    CreateIpv6Response

createLocalPeeringGateway

createNatGateway

  • Creates a new NAT gateway for the specified VCN. You must also set up a route rule with the NAT gateway as the rule's target. See RouteTable.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateNatGateway API.

    Parameters

    Returns Promise<CreateNatGatewayResponse>

    CreateNatGatewayResponse

createNetworkSecurityGroup

createPrivateIp

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreatePrivateIp API.

    Parameters

    Returns Promise<CreatePrivateIpResponse>

    CreatePrivateIpResponse

createPublicIp

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the primary private IP you want to assign the public IP to. The public IP is created in the same availability domain as the private IP. An ephemeral public IP must always be assigned to a private IP, and only to the *primary* private IP on a VNIC, not a secondary private IP. Exception: If you create a NatGateway, Oracle automatically assigns the NAT gateway a regional ephemeral public IP that you cannot remove.

    **For a reserved public IP:** You may also optionally assign the public IP to a private IP by specifying `privateIpId`. Or you can later assign the public IP with {@link #updatePublicIp(UpdatePublicIpRequest) updatePublicIp}.

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreatePublicIp API.

    Parameters

    Returns Promise<CreatePublicIpResponse>

    CreatePublicIpResponse

createPublicIpPool

createRemotePeeringConnection

createRouteTable

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateRouteTable API.

    Parameters

    Returns Promise<CreateRouteTableResponse>

    CreateRouteTableResponse

createSecurityList

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSecurityList API.

    Parameters

    Returns Promise<CreateSecurityListResponse>

    CreateSecurityListResponse

createServiceGateway

  • Creates a new service gateway in the specified compartment.

    For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateServiceGateway API.

    Parameters

    Returns Promise<CreateServiceGatewayResponse>

    CreateServiceGatewayResponse

createSubnet

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).

    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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/securitylists.htm).

    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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingDHCP.htm).

    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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSubnet API.

    Parameters

    Returns Promise<CreateSubnetResponse>

    CreateSubnetResponse

createVcn

  • 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](https://tools.ietf.org/html/rfc1918) (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).

    The VCN automatically comes with a default route table, default security list, and default set of DHCP options. The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/overview.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateVcn API.

    Parameters

    Returns Promise<CreateVcnResponse>

    CreateVcnResponse

createVirtualCircuit

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateVirtualCircuit API.

    Parameters

    Returns Promise<CreateVirtualCircuitResponse>

    CreateVirtualCircuitResponse

createVlan

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateVlan API.

    Parameters

    Returns Promise<CreateVlanResponse>

    CreateVlanResponse

createVtap

  • Creates a virtual test access point (VTAP) in the specified compartment.

    For the purposes of access control, you must provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the VTAP. For more information about compartments and access control, see [Overview of the IAM Service](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/overview.htm). For information about OCIDs, see [Resource Identifiers](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateVtap API.

    Parameters

    Returns Promise<CreateVtapResponse>

    CreateVtapResponse

createWaiters

  • Creates a new VirtualNetworkWaiter for resources for this service.

    Parameters

    • workRequestClient: WorkRequestClient

      The work request service client used to query for work request status

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns VirtualNetworkWaiter

    The service waiters.

deleteByoipRange

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteByoipRange API.

    Parameters

    Returns Promise<DeleteByoipRangeResponse>

    DeleteByoipRangeResponse

deleteCaptureFilter

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCaptureFilter API.

    Parameters

    Returns Promise<DeleteCaptureFilterResponse>

    DeleteCaptureFilterResponse

deleteCpe

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCpe API.

    Parameters

    Returns Promise<DeleteCpeResponse>

    DeleteCpeResponse

deleteCrossConnect

deleteCrossConnectGroup

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteCrossConnectGroup API.

    Parameters

    Returns Promise<DeleteCrossConnectGroupResponse>

    DeleteCrossConnectGroupResponse

deleteDhcpOptions

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDhcpOptions API.

    Parameters

    Returns Promise<DeleteDhcpOptionsResponse>

    DeleteDhcpOptionsResponse

deleteDrg

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDrg API.

    Parameters

    Returns Promise<DeleteDrgResponse>

    DeleteDrgResponse

deleteDrgAttachment

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDrgAttachment API.

    Parameters

    Returns Promise<DeleteDrgAttachmentResponse>

    DeleteDrgAttachmentResponse

deleteDrgRouteDistribution

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDrgRouteDistribution API.

    Parameters

    Returns Promise<DeleteDrgRouteDistributionResponse>

    DeleteDrgRouteDistributionResponse

deleteDrgRouteTable

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteDrgRouteTable API.

    Parameters

    Returns Promise<DeleteDrgRouteTableResponse>

    DeleteDrgRouteTableResponse

deleteIPSecConnection

  • 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 {@link #createIPSecConnection(CreateIPSecConnectionRequest) createIPSecConnection}.

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteIPSecConnection API.

    Parameters

    Returns Promise<DeleteIPSecConnectionResponse>

    DeleteIPSecConnectionResponse

deleteInternetGateway

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteInternetGateway API.

    Parameters

    Returns Promise<DeleteInternetGatewayResponse>

    DeleteInternetGatewayResponse

deleteIpv6

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteIpv6 API.

    Parameters

    Returns Promise<DeleteIpv6Response>

    DeleteIpv6Response

deleteLocalPeeringGateway

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteLocalPeeringGateway API.

    Parameters

    Returns Promise<DeleteLocalPeeringGatewayResponse>

    DeleteLocalPeeringGatewayResponse

deleteNatGateway

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteNatGateway API.

    Parameters

    Returns Promise<DeleteNatGatewayResponse>

    DeleteNatGatewayResponse

deleteNetworkSecurityGroup

  • 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 {@link #listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest) listNetworkSecurityGroupVnics}. Each returned NetworkSecurityGroupVnic object contains both the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC and the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the VNIC's parent resource (for example, the Compute instance that the VNIC is attached to).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteNetworkSecurityGroup API.

    Parameters

    Returns Promise<DeleteNetworkSecurityGroupResponse>

    DeleteNetworkSecurityGroupResponse

deletePrivateIp

  • 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](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingroutetables.htm#privateip), unassigning it from the VNIC causes that route rule to blackhole and the traffic will be dropped.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeletePrivateIp API.

    Parameters

    Returns Promise<DeletePrivateIpResponse>

    DeletePrivateIpResponse

deletePublicIp

  • 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 {@link #updatePublicIp(UpdatePublicIpRequest) updatePublicIp}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeletePublicIp API.

    Parameters

    Returns Promise<DeletePublicIpResponse>

    DeletePublicIpResponse

deletePublicIpPool

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeletePublicIpPool API.

    Parameters

    Returns Promise<DeletePublicIpPoolResponse>

    DeletePublicIpPoolResponse

deleteRemotePeeringConnection

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRemotePeeringConnection API.

    Parameters

    Returns Promise<DeleteRemotePeeringConnectionResponse>

    DeleteRemotePeeringConnectionResponse

deleteRouteTable

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteRouteTable API.

    Parameters

    Returns Promise<DeleteRouteTableResponse>

    DeleteRouteTableResponse

deleteSecurityList

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSecurityList API.

    Parameters

    Returns Promise<DeleteSecurityListResponse>

    DeleteSecurityListResponse

deleteServiceGateway

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteServiceGateway API.

    Parameters

    Returns Promise<DeleteServiceGatewayResponse>

    DeleteServiceGatewayResponse

deleteSubnet

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSubnet API.

    Parameters

    Returns Promise<DeleteSubnetResponse>

    DeleteSubnetResponse

deleteVcn

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteVcn API.

    Parameters

    Returns Promise<DeleteVcnResponse>

    DeleteVcnResponse

deleteVirtualCircuit

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteVirtualCircuit API.

    Parameters

    Returns Promise<DeleteVirtualCircuitResponse>

    DeleteVirtualCircuitResponse

deleteVlan

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteVlan API.

    Parameters

    Returns Promise<DeleteVlanResponse>

    DeleteVlanResponse

deleteVtap

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteVtap API.

    Parameters

    Returns Promise<DeleteVtapResponse>

    DeleteVtapResponse

detachServiceId

  • Removes the specified Service from the list of enabled Service objects for the specified gateway. You do not need to remove any route rules that specify this Service object's cidrBlock as the destination CIDR. However, consider removing the rules if your intent is to permanently disable use of the Service through this service gateway.

    *Note:** The `DetachServiceId` operation is an easy way to remove an individual `Service` from the service gateway. Compare it with {@link #updateServiceGateway(UpdateServiceGatewayRequest) updateServiceGateway}, 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DetachServiceId API.

    Parameters

    Returns Promise<DetachServiceIdResponse>

    DetachServiceIdResponse

getAllAllDrgAttachments

  • NOTE: This function is deprecated in favor of getAllDrgAttachmentsRecordIterator function. Creates a new async iterator which will iterate over the models.DrgAttachmentInfo objects contained in responses from the getAllDrgAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgAttachmentInfo>

getAllAllDrgAttachmentsResponses

  • NOTE: This function is deprecated in favor of getAllDrgAttachmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the getAllDrgAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<GetAllDrgAttachmentsResponse>

getAllDrgAttachments

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetAllDrgAttachments API.

    Parameters

    Returns Promise<GetAllDrgAttachmentsResponse>

    GetAllDrgAttachmentsResponse

getAllDrgAttachmentsRecordIterator

  • Creates a new async iterator which will iterate over the models.DrgAttachmentInfo objects contained in responses from the getAllDrgAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgAttachmentInfo>

getAllDrgAttachmentsResponseIterator

getAllowedIkeIPSecParameters

getByoipRange

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetByoipRange API.

    Parameters

    Returns Promise<GetByoipRangeResponse>

    GetByoipRangeResponse

getCaptureFilter

  • Gets information about the specified VTAP capture filter. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCaptureFilter API.

    Parameters

    Returns Promise<GetCaptureFilterResponse>

    GetCaptureFilterResponse

getCpe

  • Gets the specified CPE's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCpe API.

    Parameters

    Returns Promise<GetCpeResponse>

    GetCpeResponse

getCpeDeviceConfigContent

  • Renders a set of CPE configuration content that can help a network engineer configure the actual CPE device (for example, a hardware router) represented by the specified Cpe object.

    The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe must have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content optionally includes answers that the customer provides (see {@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}), merged with a template of other information specific to the CPE device type.

    The operation returns configuration information for *all* of the IPSecConnection objects that use the specified CPE. Here are similar operations:

    {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} returns CPE configuration content for all IPSec tunnels in a single IPSec connection. * {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent} returns CPE configuration content for a specific IPSec tunnel in an IPSec connection.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCpeDeviceConfigContent API.

    Parameters

    Returns Promise<GetCpeDeviceConfigContentResponse>

    GetCpeDeviceConfigContentResponse

getCpeDeviceShape

  • 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 {@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}). The service merges the answers with a template of other information for the CPE device type. The following operations return the merged content:

    {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} * {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} * {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent}

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCpeDeviceShape API.

    Parameters

    Returns Promise<GetCpeDeviceShapeResponse>

    GetCpeDeviceShapeResponse

getCrossConnect

  • Gets the specified cross-connect's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCrossConnect API.

    Parameters

    Returns Promise<GetCrossConnectResponse>

    GetCrossConnectResponse

getCrossConnectGroup

  • Gets the specified cross-connect group's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCrossConnectGroup API.

    Parameters

    Returns Promise<GetCrossConnectGroupResponse>

    GetCrossConnectGroupResponse

getCrossConnectLetterOfAuthority

getCrossConnectStatus

  • Gets the status of the specified cross-connect.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetCrossConnectStatus API.

    Parameters

    Returns Promise<GetCrossConnectStatusResponse>

    GetCrossConnectStatusResponse

getDhcpOptions

  • Gets the specified set of DHCP options. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDhcpOptions API.

    Parameters

    Returns Promise<GetDhcpOptionsResponse>

    GetDhcpOptionsResponse

getDrg

  • Gets the specified DRG's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDrg API.

    Parameters

    Returns Promise<GetDrgResponse>

    GetDrgResponse

getDrgAttachment

getDrgRedundancyStatus

getDrgRouteDistribution

getDrgRouteTable

  • Gets the specified DRG route table's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetDrgRouteTable API.

    Parameters

    Returns Promise<GetDrgRouteTableResponse>

    GetDrgRouteTableResponse

getFastConnectProviderService

getFastConnectProviderServiceKey

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetFastConnectProviderServiceKey API.

    Parameters

    Returns Promise<GetFastConnectProviderServiceKeyResponse>

    GetFastConnectProviderServiceKeyResponse

getIPSecConnection

  • 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 {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIPSecConnection API.

    Parameters

    Returns Promise<GetIPSecConnectionResponse>

    GetIPSecConnectionResponse

getIPSecConnectionDeviceConfig

  • Deprecated. To get tunnel information, instead use:

    {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel} * {@link #getIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest) getIPSecConnectionTunnelSharedSecret}

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIPSecConnectionDeviceConfig API.

    Parameters

    Returns Promise<GetIPSecConnectionDeviceConfigResponse>

    GetIPSecConnectionDeviceConfigResponse

getIPSecConnectionDeviceStatus

  • Deprecated. To get the tunnel status, instead use {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIPSecConnectionDeviceStatus API.

    Parameters

    Returns Promise<GetIPSecConnectionDeviceStatusResponse>

    GetIPSecConnectionDeviceStatusResponse

getIPSecConnectionTunnel

  • Gets the specified tunnel's information. The resulting object does not include the tunnel's shared secret (pre-shared key). To retrieve that, use {@link #getIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest) getIPSecConnectionTunnelSharedSecret}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIPSecConnectionTunnel API.

    Parameters

    Returns Promise<GetIPSecConnectionTunnelResponse>

    GetIPSecConnectionTunnelResponse

getIPSecConnectionTunnelError

getIPSecConnectionTunnelSharedSecret

  • Gets the specified tunnel's shared secret (pre-shared key). To get other information about the tunnel, use {@link #getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest) getIPSecConnectionTunnel}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIPSecConnectionTunnelSharedSecret API.

    Parameters

    Returns Promise<GetIPSecConnectionTunnelSharedSecretResponse>

    GetIPSecConnectionTunnelSharedSecretResponse

getInternetGateway

getIpsecCpeDeviceConfigContent

  • Renders a set of CPE configuration content for the specified IPSec connection (for all the tunnels in the connection). The content helps a network engineer configure the actual CPE device (for example, a hardware router) that the specified IPSec connection terminates on.

    The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe used by the specified IPSecConnection must have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content optionally includes answers that the customer provides (see {@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}), merged with a template of other information specific to the CPE device type.

    The operation returns configuration information for all tunnels in the single specified IPSecConnection object. Here are other similar operations:

    {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent} returns CPE configuration content for a specific tunnel within an IPSec connection. * {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} returns CPE configuration content for *all* IPSec connections that use a specific CPE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIpsecCpeDeviceConfigContent API.

    Parameters

    Returns Promise<GetIpsecCpeDeviceConfigContentResponse>

    GetIpsecCpeDeviceConfigContentResponse

getIpv6

  • Gets the specified IPv6. You must specify the object's OCID. Alternatively, you can get the object by using {@link #listIpv6s(ListIpv6sRequest) listIpv6s} with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet OCID.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetIpv6 API.

    Parameters

    Returns Promise<GetIpv6Response>

    GetIpv6Response

getLocalPeeringGateway

getNatGateway

  • Gets the specified NAT gateway's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetNatGateway API.

    Parameters

    Returns Promise<GetNatGatewayResponse>

    GetNatGatewayResponse

getNetworkSecurityGroup

  • Gets the specified network security group's information.

    To list the VNICs in an NSG, see {@link #listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest) listNetworkSecurityGroupVnics}.

    To list the security rules in an NSG, see {@link #listNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest) listNetworkSecurityGroupSecurityRules}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetNetworkSecurityGroup API.

    Parameters

    Returns Promise<GetNetworkSecurityGroupResponse>

    GetNetworkSecurityGroupResponse

getNetworkingTopology

getPrivateIp

  • Gets the specified private IP. You must specify the object's OCID. Alternatively, you can get the object by using {@link #listPrivateIps(ListPrivateIpsRequest) listPrivateIps} with the private IP address (for example, 10.0.3.3) and subnet OCID.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPrivateIp API.

    Parameters

    Returns Promise<GetPrivateIpResponse>

    GetPrivateIpResponse

getPublicIp

  • Gets the specified public IP. You must specify the object's OCID.

    Alternatively, you can get the object by using {@link #getPublicIpByIpAddress(GetPublicIpByIpAddressRequest) getPublicIpByIpAddress} with the public IP address (for example, 203.0.113.2).

    Or you can use {@link #getPublicIpByPrivateIpId(GetPublicIpByPrivateIpIdRequest) getPublicIpByPrivateIpId} with the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPublicIp API.

    Parameters

    Returns Promise<GetPublicIpResponse>

    GetPublicIpResponse

getPublicIpByIpAddress

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPublicIpByIpAddress API.

    Parameters

    Returns Promise<GetPublicIpByIpAddressResponse>

    GetPublicIpByIpAddressResponse

getPublicIpByPrivateIpId

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the original private IP, this operation returns a 404. If you instead provide the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target private IP, or if you instead call {@link #getPublicIp(GetPublicIpRequest) getPublicIp} or {@link #getPublicIpByIpAddress(GetPublicIpByIpAddressRequest) getPublicIpByIpAddress}, the service returns the public IP object with `lifecycleState` = ASSIGNING and `assignedEntityId` = [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the target private IP.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPublicIpByPrivateIpId API.

    Parameters

    Returns Promise<GetPublicIpByPrivateIpIdResponse>

    GetPublicIpByPrivateIpIdResponse

getPublicIpPool

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetPublicIpPool API.

    Parameters

    Returns Promise<GetPublicIpPoolResponse>

    GetPublicIpPoolResponse

getRemotePeeringConnection

getRouteTable

  • Gets the specified route table's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetRouteTable API.

    Parameters

    Returns Promise<GetRouteTableResponse>

    GetRouteTableResponse

getSecurityList

  • Gets the specified security list's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSecurityList API.

    Parameters

    Returns Promise<GetSecurityListResponse>

    GetSecurityListResponse

getService

getServiceGateway

getSubnet

  • Gets the specified subnet's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSubnet API.

    Parameters

    Returns Promise<GetSubnetResponse>

    GetSubnetResponse

getSubnetTopology

getTunnelCpeDeviceConfig

  • Gets the set of CPE configuration answers for the tunnel, which the customer provided in {@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}. 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 {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTunnelCpeDeviceConfig API.

    Parameters

    Returns Promise<GetTunnelCpeDeviceConfigResponse>

    GetTunnelCpeDeviceConfigResponse

getTunnelCpeDeviceConfigContent

  • Renders a set of CPE configuration content for the specified IPSec tunnel. The content helps a network engineer configure the actual CPE device (for example, a hardware router) that the specified IPSec tunnel terminates on.

    The rendered content is specific to the type of CPE device (for example, Cisco ASA). Therefore the Cpe used by the specified IPSecConnection must have the CPE's device type specified by the `cpeDeviceShapeId` attribute. The content optionally includes answers that the customer provides (see {@link #updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest) updateTunnelCpeDeviceConfig}), 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:

    {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} returns CPE configuration content for all tunnels in a single IPSec connection. * {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} returns CPE configuration content for *all* IPSec connections that use a specific CPE.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetTunnelCpeDeviceConfigContent API.

    Parameters

    Returns Promise<GetTunnelCpeDeviceConfigContentResponse>

    GetTunnelCpeDeviceConfigContentResponse

getUpgradeStatus

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetUpgradeStatus API.

    Parameters

    Returns Promise<GetUpgradeStatusResponse>

    GetUpgradeStatusResponse

getVcn

  • Gets the specified VCN's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVcn API.

    Parameters

    Returns Promise<GetVcnResponse>

    GetVcnResponse

getVcnDnsResolverAssociation

getVcnTopology

  • Gets a virtual network topology for a given VCN. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVcnTopology API.

    Parameters

    Returns Promise<GetVcnTopologyResponse>

    GetVcnTopologyResponse

getVirtualCircuit

  • Gets the specified virtual circuit's information. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVirtualCircuit API.

    Parameters

    Returns Promise<GetVirtualCircuitResponse>

    GetVirtualCircuitResponse

getVlan

  • Gets the specified VLAN's information. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVlan API.

    Parameters

    Returns Promise<GetVlanResponse>

    GetVlanResponse

getVnic

  • Gets the information for the specified virtual network interface card (VNIC). You can get the VNIC OCID from the {@link #listVnicAttachments(ListVnicAttachmentsRequest) listVnicAttachments} operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVnic API.

    Parameters

    Returns Promise<GetVnicResponse>

    GetVnicResponse

getVtap

  • Gets the specified Vtap resource. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetVtap API.

    Parameters

    Returns Promise<GetVtapResponse>

    GetVtapResponse

getWaiters

listAllCaptureFilters

  • NOTE: This function is deprecated in favor of listCaptureFiltersRecordIterator function. Creates a new async iterator which will iterate over the models.CaptureFilter objects contained in responses from the listCaptureFilters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CaptureFilter>

listAllCaptureFiltersResponses

  • NOTE: This function is deprecated in favor of listCaptureFiltersResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCaptureFilters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCaptureFiltersResponse>

listAllCpeDeviceShapes

  • NOTE: This function is deprecated in favor of listCpeDeviceShapesRecordIterator function. Creates a new async iterator which will iterate over the models.CpeDeviceShapeSummary objects contained in responses from the listCpeDeviceShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CpeDeviceShapeSummary>

listAllCpeDeviceShapesResponses

  • NOTE: This function is deprecated in favor of listCpeDeviceShapesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCpeDeviceShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCpeDeviceShapesResponse>

listAllCpes

  • NOTE: This function is deprecated in favor of listCpesRecordIterator function. Creates a new async iterator which will iterate over the models.Cpe objects contained in responses from the listCpes operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListCpesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Cpe>

listAllCpesResponses

  • NOTE: This function is deprecated in favor of listCpesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCpes operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListCpesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListCpesResponse>

listAllCrossConnectGroups

  • NOTE: This function is deprecated in favor of listCrossConnectGroupsRecordIterator function. Creates a new async iterator which will iterate over the models.CrossConnectGroup objects contained in responses from the listCrossConnectGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CrossConnectGroup>

listAllCrossConnectGroupsResponses

  • NOTE: This function is deprecated in favor of listCrossConnectGroupsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCrossConnectGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCrossConnectGroupsResponse>

listAllCrossConnectLocations

  • NOTE: This function is deprecated in favor of listCrossConnectLocationsRecordIterator function. Creates a new async iterator which will iterate over the models.CrossConnectLocation objects contained in responses from the listCrossConnectLocations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CrossConnectLocation>

listAllCrossConnectLocationsResponses

  • NOTE: This function is deprecated in favor of listCrossConnectLocationsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCrossConnectLocations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCrossConnectLocationsResponse>

listAllCrossConnects

  • NOTE: This function is deprecated in favor of listCrossConnectsRecordIterator function. Creates a new async iterator which will iterate over the models.CrossConnect objects contained in responses from the listCrossConnects operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CrossConnect>

listAllCrossConnectsResponses

  • NOTE: This function is deprecated in favor of listCrossConnectsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listCrossConnects operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListCrossConnectsResponse>

listAllCrossconnectPortSpeedShapes

  • NOTE: This function is deprecated in favor of listCrossconnectPortSpeedShapesRecordIterator function. Creates a new async iterator which will iterate over the models.CrossConnectPortSpeedShape objects contained in responses from the listCrossconnectPortSpeedShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CrossConnectPortSpeedShape>

listAllCrossconnectPortSpeedShapesResponses

listAllDhcpOptions

  • NOTE: This function is deprecated in favor of listDhcpOptionsRecordIterator function. Creates a new async iterator which will iterate over the models.DhcpOptions objects contained in responses from the listDhcpOptions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DhcpOptions>

listAllDhcpOptionsResponses

  • NOTE: This function is deprecated in favor of listDhcpOptionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDhcpOptions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDhcpOptionsResponse>

listAllDrgAttachments

  • NOTE: This function is deprecated in favor of listDrgAttachmentsRecordIterator function. Creates a new async iterator which will iterate over the models.DrgAttachment objects contained in responses from the listDrgAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgAttachment>

listAllDrgAttachmentsResponses

  • NOTE: This function is deprecated in favor of listDrgAttachmentsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDrgAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDrgAttachmentsResponse>

listAllDrgRouteDistributionStatements

  • NOTE: This function is deprecated in favor of listDrgRouteDistributionStatementsRecordIterator function. Creates a new async iterator which will iterate over the models.DrgRouteDistributionStatement objects contained in responses from the listDrgRouteDistributionStatements operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgRouteDistributionStatement>

listAllDrgRouteDistributionStatementsResponses

listAllDrgRouteDistributions

  • NOTE: This function is deprecated in favor of listDrgRouteDistributionsRecordIterator function. Creates a new async iterator which will iterate over the models.DrgRouteDistribution objects contained in responses from the listDrgRouteDistributions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgRouteDistribution>

listAllDrgRouteDistributionsResponses

  • NOTE: This function is deprecated in favor of listDrgRouteDistributionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDrgRouteDistributions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDrgRouteDistributionsResponse>

listAllDrgRouteRules

  • NOTE: This function is deprecated in favor of listDrgRouteRulesRecordIterator function. Creates a new async iterator which will iterate over the models.DrgRouteRule objects contained in responses from the listDrgRouteRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgRouteRule>

listAllDrgRouteRulesResponses

  • NOTE: This function is deprecated in favor of listDrgRouteRulesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDrgRouteRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDrgRouteRulesResponse>

listAllDrgRouteTables

  • NOTE: This function is deprecated in favor of listDrgRouteTablesRecordIterator function. Creates a new async iterator which will iterate over the models.DrgRouteTable objects contained in responses from the listDrgRouteTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgRouteTable>

listAllDrgRouteTablesResponses

  • NOTE: This function is deprecated in favor of listDrgRouteTablesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDrgRouteTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListDrgRouteTablesResponse>

listAllDrgs

  • NOTE: This function is deprecated in favor of listDrgsRecordIterator function. Creates a new async iterator which will iterate over the models.Drg objects contained in responses from the listDrgs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListDrgsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Drg>

listAllDrgsResponses

  • NOTE: This function is deprecated in favor of listDrgsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listDrgs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListDrgsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListDrgsResponse>

listAllFastConnectProviderServices

  • NOTE: This function is deprecated in favor of listFastConnectProviderServicesRecordIterator function. Creates a new async iterator which will iterate over the models.FastConnectProviderService objects contained in responses from the listFastConnectProviderServices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<FastConnectProviderService>

listAllFastConnectProviderServicesResponses

listAllFastConnectProviderVirtualCircuitBandwidthShapes

  • NOTE: This function is deprecated in favor of listFastConnectProviderVirtualCircuitBandwidthShapesRecordIterator function. Creates a new async iterator which will iterate over the models.VirtualCircuitBandwidthShape objects contained in responses from the listFastConnectProviderVirtualCircuitBandwidthShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VirtualCircuitBandwidthShape>

listAllFastConnectProviderVirtualCircuitBandwidthShapesResponses

listAllIPSecConnectionTunnelRoutes

  • NOTE: This function is deprecated in favor of listIPSecConnectionTunnelRoutesRecordIterator function. Creates a new async iterator which will iterate over the models.TunnelRouteSummary objects contained in responses from the listIPSecConnectionTunnelRoutes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TunnelRouteSummary>

listAllIPSecConnectionTunnelRoutesResponses

listAllIPSecConnectionTunnelSecurityAssociations

  • NOTE: This function is deprecated in favor of listIPSecConnectionTunnelSecurityAssociationsRecordIterator function. Creates a new async iterator which will iterate over the models.TunnelSecurityAssociationSummary objects contained in responses from the listIPSecConnectionTunnelSecurityAssociations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TunnelSecurityAssociationSummary>

listAllIPSecConnectionTunnelSecurityAssociationsResponses

listAllIPSecConnectionTunnels

  • NOTE: This function is deprecated in favor of listIPSecConnectionTunnelsRecordIterator function. Creates a new async iterator which will iterate over the models.IPSecConnectionTunnel objects contained in responses from the listIPSecConnectionTunnels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IPSecConnectionTunnel>

listAllIPSecConnectionTunnelsResponses

  • NOTE: This function is deprecated in favor of listIPSecConnectionTunnelsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIPSecConnectionTunnels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIPSecConnectionTunnelsResponse>

listAllIPSecConnections

  • NOTE: This function is deprecated in favor of listIPSecConnectionsRecordIterator function. Creates a new async iterator which will iterate over the models.IPSecConnection objects contained in responses from the listIPSecConnections operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IPSecConnection>

listAllIPSecConnectionsResponses

  • NOTE: This function is deprecated in favor of listIPSecConnectionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIPSecConnections operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListIPSecConnectionsResponse>

listAllInternetGateways

  • NOTE: This function is deprecated in favor of listInternetGatewaysRecordIterator function. Creates a new async iterator which will iterate over the models.InternetGateway objects contained in responses from the listInternetGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<InternetGateway>

listAllInternetGatewaysResponses

  • NOTE: This function is deprecated in favor of listInternetGatewaysResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listInternetGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListInternetGatewaysResponse>

listAllIpv6s

  • NOTE: This function is deprecated in favor of listIpv6sRecordIterator function. Creates a new async iterator which will iterate over the models.Ipv6 objects contained in responses from the listIpv6s operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListIpv6sRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Ipv6>

listAllIpv6sResponses

  • NOTE: This function is deprecated in favor of listIpv6sResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listIpv6s operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListIpv6sRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListIpv6sResponse>

listAllLocalPeeringGateways

  • NOTE: This function is deprecated in favor of listLocalPeeringGatewaysRecordIterator function. Creates a new async iterator which will iterate over the models.LocalPeeringGateway objects contained in responses from the listLocalPeeringGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<LocalPeeringGateway>

listAllLocalPeeringGatewaysResponses

  • NOTE: This function is deprecated in favor of listLocalPeeringGatewaysResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listLocalPeeringGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListLocalPeeringGatewaysResponse>

listAllNatGateways

  • NOTE: This function is deprecated in favor of listNatGatewaysRecordIterator function. Creates a new async iterator which will iterate over the models.NatGateway objects contained in responses from the listNatGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NatGateway>

listAllNatGatewaysResponses

  • NOTE: This function is deprecated in favor of listNatGatewaysResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listNatGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListNatGatewaysResponse>

listAllNetworkSecurityGroupSecurityRules

  • NOTE: This function is deprecated in favor of listNetworkSecurityGroupSecurityRulesRecordIterator function. Creates a new async iterator which will iterate over the models.SecurityRule objects contained in responses from the listNetworkSecurityGroupSecurityRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SecurityRule>

listAllNetworkSecurityGroupSecurityRulesResponses

listAllNetworkSecurityGroupVnics

  • NOTE: This function is deprecated in favor of listNetworkSecurityGroupVnicsRecordIterator function. Creates a new async iterator which will iterate over the models.NetworkSecurityGroupVnic objects contained in responses from the listNetworkSecurityGroupVnics operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NetworkSecurityGroupVnic>

listAllNetworkSecurityGroupVnicsResponses

listAllNetworkSecurityGroups

  • NOTE: This function is deprecated in favor of listNetworkSecurityGroupsRecordIterator function. Creates a new async iterator which will iterate over the models.NetworkSecurityGroup objects contained in responses from the listNetworkSecurityGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NetworkSecurityGroup>

listAllNetworkSecurityGroupsResponses

  • NOTE: This function is deprecated in favor of listNetworkSecurityGroupsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listNetworkSecurityGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListNetworkSecurityGroupsResponse>

listAllPrivateIps

  • NOTE: This function is deprecated in favor of listPrivateIpsRecordIterator function. Creates a new async iterator which will iterate over the models.PrivateIp objects contained in responses from the listPrivateIps operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PrivateIp>

listAllPrivateIpsResponses

  • NOTE: This function is deprecated in favor of listPrivateIpsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPrivateIps operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPrivateIpsResponse>

listAllPublicIps

  • NOTE: This function is deprecated in favor of listPublicIpsRecordIterator function. Creates a new async iterator which will iterate over the models.PublicIp objects contained in responses from the listPublicIps operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PublicIp>

listAllPublicIpsResponses

  • NOTE: This function is deprecated in favor of listPublicIpsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listPublicIps operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPublicIpsResponse>

listAllRemotePeeringConnections

  • NOTE: This function is deprecated in favor of listRemotePeeringConnectionsRecordIterator function. Creates a new async iterator which will iterate over the models.RemotePeeringConnection objects contained in responses from the listRemotePeeringConnections operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<RemotePeeringConnection>

listAllRemotePeeringConnectionsResponses

  • NOTE: This function is deprecated in favor of listRemotePeeringConnectionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listRemotePeeringConnections operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListRemotePeeringConnectionsResponse>

listAllRouteTables

  • NOTE: This function is deprecated in favor of listRouteTablesRecordIterator function. Creates a new async iterator which will iterate over the models.RouteTable objects contained in responses from the listRouteTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<RouteTable>

listAllRouteTablesResponses

  • NOTE: This function is deprecated in favor of listRouteTablesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listRouteTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListRouteTablesResponse>

listAllSecurityLists

  • NOTE: This function is deprecated in favor of listSecurityListsRecordIterator function. Creates a new async iterator which will iterate over the models.SecurityList objects contained in responses from the listSecurityLists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SecurityList>

listAllSecurityListsResponses

  • NOTE: This function is deprecated in favor of listSecurityListsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSecurityLists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSecurityListsResponse>

listAllServiceGateways

  • NOTE: This function is deprecated in favor of listServiceGatewaysRecordIterator function. Creates a new async iterator which will iterate over the models.ServiceGateway objects contained in responses from the listServiceGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ServiceGateway>

listAllServiceGatewaysResponses

  • NOTE: This function is deprecated in favor of listServiceGatewaysResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listServiceGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListServiceGatewaysResponse>

listAllServices

  • NOTE: This function is deprecated in favor of listServicesRecordIterator function. Creates a new async iterator which will iterate over the models.Service objects contained in responses from the listServices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Service>

listAllServicesResponses

  • NOTE: This function is deprecated in favor of listServicesResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listServices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListServicesResponse>

listAllSubnets

  • NOTE: This function is deprecated in favor of listSubnetsRecordIterator function. Creates a new async iterator which will iterate over the models.Subnet objects contained in responses from the listSubnets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Subnet>

listAllSubnetsResponses

  • NOTE: This function is deprecated in favor of listSubnetsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSubnets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSubnetsResponse>

listAllVcns

  • NOTE: This function is deprecated in favor of listVcnsRecordIterator function. Creates a new async iterator which will iterate over the models.Vcn objects contained in responses from the listVcns operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVcnsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Vcn>

listAllVcnsResponses

  • NOTE: This function is deprecated in favor of listVcnsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVcns operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVcnsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListVcnsResponse>

listAllVirtualCircuitAssociatedTunnels

  • NOTE: This function is deprecated in favor of listVirtualCircuitAssociatedTunnelsRecordIterator function. Creates a new async iterator which will iterate over the models.VirtualCircuitAssociatedTunnelDetails objects contained in responses from the listVirtualCircuitAssociatedTunnels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VirtualCircuitAssociatedTunnelDetails>

listAllVirtualCircuitAssociatedTunnelsResponses

listAllVirtualCircuitBandwidthShapes

  • NOTE: This function is deprecated in favor of listVirtualCircuitBandwidthShapesRecordIterator function. Creates a new async iterator which will iterate over the models.VirtualCircuitBandwidthShape objects contained in responses from the listVirtualCircuitBandwidthShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VirtualCircuitBandwidthShape>

listAllVirtualCircuitBandwidthShapesResponses

listAllVirtualCircuits

  • NOTE: This function is deprecated in favor of listVirtualCircuitsRecordIterator function. Creates a new async iterator which will iterate over the models.VirtualCircuit objects contained in responses from the listVirtualCircuits operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VirtualCircuit>

listAllVirtualCircuitsResponses

  • NOTE: This function is deprecated in favor of listVirtualCircuitsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVirtualCircuits operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListVirtualCircuitsResponse>

listAllVlans

  • NOTE: This function is deprecated in favor of listVlansRecordIterator function. Creates a new async iterator which will iterate over the models.Vlan objects contained in responses from the listVlans operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVlansRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Vlan>

listAllVlansResponses

  • NOTE: This function is deprecated in favor of listVlansResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVlans operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVlansRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListVlansResponse>

listAllVtaps

  • NOTE: This function is deprecated in favor of listVtapsRecordIterator function. Creates a new async iterator which will iterate over the models.Vtap objects contained in responses from the listVtaps operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVtapsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Vtap>

listAllVtapsResponses

  • NOTE: This function is deprecated in favor of listVtapsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listVtaps operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVtapsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListVtapsResponse>

listAllowedPeerRegionsForRemotePeering

listByoipAllocatedRanges

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListByoipAllocatedRanges API.

    Parameters

    Returns Promise<ListByoipAllocatedRangesResponse>

    ListByoipAllocatedRangesResponse

listByoipRanges

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListByoipRanges API.

    Parameters

    Returns Promise<ListByoipRangesResponse>

    ListByoipRangesResponse

listCaptureFilters

listCaptureFiltersRecordIterator

  • Creates a new async iterator which will iterate over the models.CaptureFilter objects contained in responses from the listCaptureFilters operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CaptureFilter>

listCaptureFiltersResponseIterator

listCpeDeviceShapes

  • Lists the CPE device types that the Networking service provides CPE configuration content for (example: Cisco ASA). The content helps a network engineer configure the actual CPE device represented by a Cpe object.

    If you want to generate CPE configuration content for one of the returned CPE device types, ensure that the Cpe object's `cpeDeviceShapeId` attribute is set to the CPE device type's [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) (returned by this operation).

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

    {@link #getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest) getCpeDeviceConfigContent} * {@link #getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest) getIpsecCpeDeviceConfigContent} * {@link #getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest) getTunnelCpeDeviceConfigContent}

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCpeDeviceShapes API.

    Parameters

    Returns Promise<ListCpeDeviceShapesResponse>

    ListCpeDeviceShapesResponse

listCpeDeviceShapesRecordIterator

  • Creates a new async iterator which will iterate over the models.CpeDeviceShapeSummary objects contained in responses from the listCpeDeviceShapes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CpeDeviceShapeSummary>

listCpeDeviceShapesResponseIterator

listCpes

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCpes API.

    Parameters

    Returns Promise<ListCpesResponse>

    ListCpesResponse

listCpesRecordIterator

  • Creates a new async iterator which will iterate over the models.Cpe objects contained in responses from the listCpes operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListCpesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Cpe>

listCpesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listCpes operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListCpesRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListCpesResponse>

listCrossConnectGroups

  • Lists the cross-connect groups in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCrossConnectGroups API.

    Parameters

    Returns Promise<ListCrossConnectGroupsResponse>

    ListCrossConnectGroupsResponse

listCrossConnectGroupsRecordIterator

  • Creates a new async iterator which will iterate over the models.CrossConnectGroup objects contained in responses from the listCrossConnectGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CrossConnectGroup>

listCrossConnectGroupsResponseIterator

listCrossConnectLocations

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCrossConnectLocations API.

    Parameters

    Returns Promise<ListCrossConnectLocationsResponse>

    ListCrossConnectLocationsResponse

listCrossConnectLocationsRecordIterator

  • Creates a new async iterator which will iterate over the models.CrossConnectLocation objects contained in responses from the listCrossConnectLocations operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CrossConnectLocation>

listCrossConnectLocationsResponseIterator

listCrossConnectMappings

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCrossConnectMappings API.

    Parameters

    Returns Promise<ListCrossConnectMappingsResponse>

    ListCrossConnectMappingsResponse

listCrossConnects

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCrossConnects API.

    Parameters

    Returns Promise<ListCrossConnectsResponse>

    ListCrossConnectsResponse

listCrossConnectsRecordIterator

  • Creates a new async iterator which will iterate over the models.CrossConnect objects contained in responses from the listCrossConnects operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<CrossConnect>

listCrossConnectsResponseIterator

listCrossconnectPortSpeedShapes

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListCrossconnectPortSpeedShapes API.

    Parameters

    Returns Promise<ListCrossconnectPortSpeedShapesResponse>

    ListCrossconnectPortSpeedShapesResponse

listCrossconnectPortSpeedShapesRecordIterator

listCrossconnectPortSpeedShapesResponseIterator

listDhcpOptions

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDhcpOptions API.

    Parameters

    Returns Promise<ListDhcpOptionsResponse>

    ListDhcpOptionsResponse

listDhcpOptionsRecordIterator

  • Creates a new async iterator which will iterate over the models.DhcpOptions objects contained in responses from the listDhcpOptions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DhcpOptions>

listDhcpOptionsResponseIterator

listDrgAttachments

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDrgAttachments API.

    Parameters

    Returns Promise<ListDrgAttachmentsResponse>

    ListDrgAttachmentsResponse

listDrgAttachmentsRecordIterator

  • Creates a new async iterator which will iterate over the models.DrgAttachment objects contained in responses from the listDrgAttachments operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgAttachment>

listDrgAttachmentsResponseIterator

listDrgRouteDistributionStatements

listDrgRouteDistributionStatementsRecordIterator

listDrgRouteDistributionStatementsResponseIterator

listDrgRouteDistributions

  • Lists the route distributions in the specified DRG.

    To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDrgRouteDistributions API.

    Parameters

    Returns Promise<ListDrgRouteDistributionsResponse>

    ListDrgRouteDistributionsResponse

listDrgRouteDistributionsRecordIterator

  • Creates a new async iterator which will iterate over the models.DrgRouteDistribution objects contained in responses from the listDrgRouteDistributions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgRouteDistribution>

listDrgRouteDistributionsResponseIterator

listDrgRouteRules

  • Lists the route rules in the specified DRG route table. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDrgRouteRules API.

    Parameters

    Returns Promise<ListDrgRouteRulesResponse>

    ListDrgRouteRulesResponse

listDrgRouteRulesRecordIterator

  • Creates a new async iterator which will iterate over the models.DrgRouteRule objects contained in responses from the listDrgRouteRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgRouteRule>

listDrgRouteRulesResponseIterator

listDrgRouteTables

  • Lists the DRG route tables for the specified DRG.

    Use the `ListDrgRouteRules` operation to retrieve the route rules in a table.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDrgRouteTables API.

    Parameters

    Returns Promise<ListDrgRouteTablesResponse>

    ListDrgRouteTablesResponse

listDrgRouteTablesRecordIterator

  • Creates a new async iterator which will iterate over the models.DrgRouteTable objects contained in responses from the listDrgRouteTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<DrgRouteTable>

listDrgRouteTablesResponseIterator

listDrgs

  • Lists the DRGs in the specified compartment.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListDrgs API.

    Parameters

    Returns Promise<ListDrgsResponse>

    ListDrgsResponse

listDrgsRecordIterator

  • Creates a new async iterator which will iterate over the models.Drg objects contained in responses from the listDrgs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListDrgsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Drg>

listDrgsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listDrgs operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListDrgsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListDrgsResponse>

listFastConnectProviderServices

  • 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of your tenancy (the root compartment).

    For more information, see [FastConnect Overview](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFastConnectProviderServices API.

    Parameters

    Returns Promise<ListFastConnectProviderServicesResponse>

    ListFastConnectProviderServicesResponse

listFastConnectProviderServicesRecordIterator

listFastConnectProviderServicesResponseIterator

listFastConnectProviderVirtualCircuitBandwidthShapes

  • 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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListFastConnectProviderVirtualCircuitBandwidthShapes API.

    Parameters

    Returns Promise<ListFastConnectProviderVirtualCircuitBandwidthShapesResponse>

    ListFastConnectProviderVirtualCircuitBandwidthShapesResponse

listFastConnectProviderVirtualCircuitBandwidthShapesRecordIterator

listFastConnectProviderVirtualCircuitBandwidthShapesResponseIterator

listIPSecConnectionTunnelRoutes

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIPSecConnectionTunnelRoutes API.

    Parameters

    Returns Promise<ListIPSecConnectionTunnelRoutesResponse>

    ListIPSecConnectionTunnelRoutesResponse

listIPSecConnectionTunnelRoutesRecordIterator

  • Creates a new async iterator which will iterate over the models.TunnelRouteSummary objects contained in responses from the listIPSecConnectionTunnelRoutes operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<TunnelRouteSummary>

listIPSecConnectionTunnelRoutesResponseIterator

listIPSecConnectionTunnelSecurityAssociations

listIPSecConnectionTunnelSecurityAssociationsRecordIterator

listIPSecConnectionTunnelSecurityAssociationsResponseIterator

listIPSecConnectionTunnels

  • Lists the tunnel information for the specified IPSec connection.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIPSecConnectionTunnels API.

    Parameters

    Returns Promise<ListIPSecConnectionTunnelsResponse>

    ListIPSecConnectionTunnelsResponse

listIPSecConnectionTunnelsRecordIterator

  • Creates a new async iterator which will iterate over the models.IPSecConnectionTunnel objects contained in responses from the listIPSecConnectionTunnels operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IPSecConnectionTunnel>

listIPSecConnectionTunnelsResponseIterator

listIPSecConnections

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIPSecConnections API.

    Parameters

    Returns Promise<ListIPSecConnectionsResponse>

    ListIPSecConnectionsResponse

listIPSecConnectionsRecordIterator

  • Creates a new async iterator which will iterate over the models.IPSecConnection objects contained in responses from the listIPSecConnections operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<IPSecConnection>

listIPSecConnectionsResponseIterator

listInternetGateways

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListInternetGateways API.

    Parameters

    Returns Promise<ListInternetGatewaysResponse>

    ListInternetGatewaysResponse

listInternetGatewaysRecordIterator

  • Creates a new async iterator which will iterate over the models.InternetGateway objects contained in responses from the listInternetGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<InternetGateway>

listInternetGatewaysResponseIterator

listIpv6s

  • Lists the Ipv6 objects based on one of these filters:

    Subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * VNIC [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). For comparison, {@link #getIpv6(GetIpv6Request) getIpv6} requires the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListIpv6s API.

    Parameters

    Returns Promise<ListIpv6sResponse>

    ListIpv6sResponse

listIpv6sRecordIterator

  • Creates a new async iterator which will iterate over the models.Ipv6 objects contained in responses from the listIpv6s operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListIpv6sRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Ipv6>

listIpv6sResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listIpv6s operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListIpv6sRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListIpv6sResponse>

listLocalPeeringGateways

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListLocalPeeringGateways API.

    Parameters

    Returns Promise<ListLocalPeeringGatewaysResponse>

    ListLocalPeeringGatewaysResponse

listLocalPeeringGatewaysRecordIterator

  • Creates a new async iterator which will iterate over the models.LocalPeeringGateway objects contained in responses from the listLocalPeeringGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<LocalPeeringGateway>

listLocalPeeringGatewaysResponseIterator

listNatGateways

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListNatGateways API.

    Parameters

    Returns Promise<ListNatGatewaysResponse>

    ListNatGatewaysResponse

listNatGatewaysRecordIterator

  • Creates a new async iterator which will iterate over the models.NatGateway objects contained in responses from the listNatGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NatGateway>

listNatGatewaysResponseIterator

listNetworkSecurityGroupSecurityRules

listNetworkSecurityGroupSecurityRulesRecordIterator

  • Creates a new async iterator which will iterate over the models.SecurityRule objects contained in responses from the listNetworkSecurityGroupSecurityRules operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SecurityRule>

listNetworkSecurityGroupSecurityRulesResponseIterator

listNetworkSecurityGroupVnics

listNetworkSecurityGroupVnicsRecordIterator

listNetworkSecurityGroupVnicsResponseIterator

listNetworkSecurityGroups

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListNetworkSecurityGroups API.

    Parameters

    Returns Promise<ListNetworkSecurityGroupsResponse>

    ListNetworkSecurityGroupsResponse

listNetworkSecurityGroupsRecordIterator

  • Creates a new async iterator which will iterate over the models.NetworkSecurityGroup objects contained in responses from the listNetworkSecurityGroups operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<NetworkSecurityGroup>

listNetworkSecurityGroupsResponseIterator

listPrivateIps

  • Lists the PrivateIp objects based on one of these filters:

    - Subnet [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - VNIC [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). - 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). For comparison, {@link #getPrivateIp(GetPrivateIpRequest) getPrivateIp} requires the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).

    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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). See Vlan.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPrivateIps API.

    Parameters

    Returns Promise<ListPrivateIpsResponse>

    ListPrivateIpsResponse

listPrivateIpsRecordIterator

  • Creates a new async iterator which will iterate over the models.PrivateIp objects contained in responses from the listPrivateIps operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PrivateIp>

listPrivateIpsResponseIterator

listPublicIpPools

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPublicIpPools API.

    Parameters

    Returns Promise<ListPublicIpPoolsResponse>

    ListPublicIpPoolsResponse

listPublicIps

  • Lists the PublicIp objects in the specified compartment. You can filter the list by using query parameters.

    To list your reserved public IPs: * Set `scope` = `REGION` (required) * Leave the `availabilityDomain` parameter empty * Set `lifetime` = `RESERVED`

    To list the ephemeral public IPs assigned to a regional entity such as a NAT gateway: * Set `scope` = `REGION` (required) * Leave the `availabilityDomain` parameter empty * Set `lifetime` = `EPHEMERAL`

    To list the ephemeral public IPs assigned to private IPs: * Set `scope` = `AVAILABILITY_DOMAIN` (required) * Set the `availabilityDomain` parameter to the desired availability domain (required) * Set `lifetime` = `EPHEMERAL`

    *Note:** An ephemeral public IP assigned to a private IP is always in the same availability domain and compartment as the private IP.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListPublicIps API.

    Parameters

    Returns Promise<ListPublicIpsResponse>

    ListPublicIpsResponse

listPublicIpsRecordIterator

  • Creates a new async iterator which will iterate over the models.PublicIp objects contained in responses from the listPublicIps operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<PublicIp>

listPublicIpsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listPublicIps operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListPublicIpsResponse>

listRemotePeeringConnections

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRemotePeeringConnections API.

    Parameters

    Returns Promise<ListRemotePeeringConnectionsResponse>

    ListRemotePeeringConnectionsResponse

listRemotePeeringConnectionsRecordIterator

listRemotePeeringConnectionsResponseIterator

listRouteTables

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListRouteTables API.

    Parameters

    Returns Promise<ListRouteTablesResponse>

    ListRouteTablesResponse

listRouteTablesRecordIterator

  • Creates a new async iterator which will iterate over the models.RouteTable objects contained in responses from the listRouteTables operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<RouteTable>

listRouteTablesResponseIterator

listSecurityLists

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSecurityLists API.

    Parameters

    Returns Promise<ListSecurityListsResponse>

    ListSecurityListsResponse

listSecurityListsRecordIterator

  • Creates a new async iterator which will iterate over the models.SecurityList objects contained in responses from the listSecurityLists operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SecurityList>

listSecurityListsResponseIterator

listServiceGateways

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListServiceGateways API.

    Parameters

    Returns Promise<ListServiceGatewaysResponse>

    ListServiceGatewaysResponse

listServiceGatewaysRecordIterator

  • Creates a new async iterator which will iterate over the models.ServiceGateway objects contained in responses from the listServiceGateways operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ServiceGateway>

listServiceGatewaysResponseIterator

listServices

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListServices API.

    Parameters

    Returns Promise<ListServicesResponse>

    ListServicesResponse

listServicesRecordIterator

  • Creates a new async iterator which will iterate over the models.Service objects contained in responses from the listServices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Service>

listServicesResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listServices operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListServicesResponse>

listSubnets

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSubnets API.

    Parameters

    Returns Promise<ListSubnetsResponse>

    ListSubnetsResponse

listSubnetsRecordIterator

  • Creates a new async iterator which will iterate over the models.Subnet objects contained in responses from the listSubnets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<Subnet>

listSubnetsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listSubnets operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSubnetsResponse>

listVcns

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVcns API.

    Parameters

    Returns Promise<ListVcnsResponse>

    ListVcnsResponse

listVcnsRecordIterator

  • Creates a new async iterator which will iterate over the models.Vcn objects contained in responses from the listVcns operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVcnsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Vcn>

listVcnsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listVcns operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVcnsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListVcnsResponse>

listVirtualCircuitAssociatedTunnels

listVirtualCircuitAssociatedTunnelsRecordIterator

listVirtualCircuitAssociatedTunnelsResponseIterator

listVirtualCircuitBandwidthShapes

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVirtualCircuitBandwidthShapes API.

    Parameters

    Returns Promise<ListVirtualCircuitBandwidthShapesResponse>

    ListVirtualCircuitBandwidthShapesResponse

listVirtualCircuitBandwidthShapesRecordIterator

listVirtualCircuitBandwidthShapesResponseIterator

listVirtualCircuitPublicPrefixes

listVirtualCircuits

  • Lists the virtual circuits in the specified compartment.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVirtualCircuits API.

    Parameters

    Returns Promise<ListVirtualCircuitsResponse>

    ListVirtualCircuitsResponse

listVirtualCircuitsRecordIterator

  • Creates a new async iterator which will iterate over the models.VirtualCircuit objects contained in responses from the listVirtualCircuits operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<VirtualCircuit>

listVirtualCircuitsResponseIterator

listVlans

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVlans API.

    Parameters

    Returns Promise<ListVlansResponse>

    ListVlansResponse

listVlansRecordIterator

  • Creates a new async iterator which will iterate over the models.Vlan objects contained in responses from the listVlans operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVlansRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Vlan>

listVlansResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listVlans operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVlansRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListVlansResponse>

listVtaps

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListVtaps API.

    Parameters

    Returns Promise<ListVtapsResponse>

    ListVtapsResponse

listVtapsRecordIterator

  • Creates a new async iterator which will iterate over the models.Vtap objects contained in responses from the listVtaps operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVtapsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<Vtap>

listVtapsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listVtaps operation. This iterator will fetch more data from the server as needed.

    Parameters

    • request: ListVtapsRequest

      a request which can be sent to the service operation

    Returns AsyncIterableIterator<ListVtapsResponse>

modifyVcnCidr

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ModifyVcnCidr API.

    Parameters

    Returns Promise<ModifyVcnCidrResponse>

    ModifyVcnCidrResponse

removeDrgRouteDistributionStatements

removeDrgRouteRules

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveDrgRouteRules API.

    Parameters

    Returns Promise<RemoveDrgRouteRulesResponse>

    RemoveDrgRouteRulesResponse

removeExportDrgRouteDistribution

removeImportDrgRouteDistribution

removeIpv6SubnetCidr

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveIpv6SubnetCidr API.

    Parameters

    Returns Promise<RemoveIpv6SubnetCidrResponse>

    RemoveIpv6SubnetCidrResponse

removeIpv6VcnCidr

removeNetworkSecurityGroupSecurityRules

removePublicIpPoolCapacity

removeVcnCidr

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use RemoveVcnCidr API.

    Parameters

    Returns Promise<RemoveVcnCidrResponse>

    RemoveVcnCidrResponse

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateByoipRange

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateByoipRange API.

    Parameters

    Returns Promise<UpdateByoipRangeResponse>

    UpdateByoipRangeResponse

updateCaptureFilter

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCaptureFilter API.

    Parameters

    Returns Promise<UpdateCaptureFilterResponse>

    UpdateCaptureFilterResponse

updateCpe

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCpe API.

    Parameters

    Returns Promise<UpdateCpeResponse>

    UpdateCpeResponse

updateCrossConnect

  • Updates the specified cross-connect. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCrossConnect API.

    Parameters

    Returns Promise<UpdateCrossConnectResponse>

    UpdateCrossConnectResponse

updateCrossConnectGroup

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateCrossConnectGroup API.

    Parameters

    Returns Promise<UpdateCrossConnectGroupResponse>

    UpdateCrossConnectGroupResponse

updateDhcpOptions

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDhcpOptions API.

    Parameters

    Returns Promise<UpdateDhcpOptionsResponse>

    UpdateDhcpOptionsResponse

updateDrg

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDrg API.

    Parameters

    Returns Promise<UpdateDrgResponse>

    UpdateDrgResponse

updateDrgAttachment

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDrgAttachment API.

    Parameters

    Returns Promise<UpdateDrgAttachmentResponse>

    UpdateDrgAttachmentResponse

updateDrgRouteDistribution

updateDrgRouteDistributionStatements

updateDrgRouteRules

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateDrgRouteRules API.

    Parameters

    Returns Promise<UpdateDrgRouteRulesResponse>

    UpdateDrgRouteRulesResponse

updateDrgRouteTable

updateIPSecConnection

  • Updates the specified IPSec connection.

    To update an individual IPSec tunnel's attributes, use {@link #updateIPSecConnectionTunnel(UpdateIPSecConnectionTunnelRequest) updateIPSecConnectionTunnel}.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateIPSecConnection API.

    Parameters

    Returns Promise<UpdateIPSecConnectionResponse>

    UpdateIPSecConnectionResponse

updateIPSecConnectionTunnel

  • 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 ({@link #bgpSessionInfo(BgpSessionInfoRequest) bgpSessionInfo}).

    If you want to switch the tunnel's `routing` from `BGP` to `STATIC`, make sure the IPSecConnection already has at least one valid CIDR static route.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateIPSecConnectionTunnel API.

    Parameters

    Returns Promise<UpdateIPSecConnectionTunnelResponse>

    UpdateIPSecConnectionTunnelResponse

updateIPSecConnectionTunnelSharedSecret

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateIPSecConnectionTunnelSharedSecret API.

    Parameters

    Returns Promise<UpdateIPSecConnectionTunnelSharedSecretResponse>

    UpdateIPSecConnectionTunnelSharedSecretResponse

updateInternetGateway

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateInternetGateway API.

    Parameters

    Returns Promise<UpdateInternetGatewayResponse>

    UpdateInternetGatewayResponse

updateIpv6

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateIpv6 API.

    Parameters

    Returns Promise<UpdateIpv6Response>

    UpdateIpv6Response

updateLocalPeeringGateway

updateNatGateway

updateNetworkSecurityGroup

  • Updates the specified network security group.

    To add or remove an existing VNIC from the group, use {@link #updateVnic(UpdateVnicRequest) updateVnic}.

    To add a VNIC to the group *when you create the VNIC*, specify the NSG's [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) during creation. For example, see the `nsgIds` attribute in {@link #createVnicDetails(CreateVnicDetailsRequest) createVnicDetails}.

    To add or remove security rules from the group, use {@link #addNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest) addNetworkSecurityGroupSecurityRules} or {@link #removeNetworkSecurityGroupSecurityRules(RemoveNetworkSecurityGroupSecurityRulesRequest) removeNetworkSecurityGroupSecurityRules}.

    To edit the contents of existing security rules in the group, use {@link #updateNetworkSecurityGroupSecurityRules(UpdateNetworkSecurityGroupSecurityRulesRequest) updateNetworkSecurityGroupSecurityRules}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateNetworkSecurityGroup API.

    Parameters

    Returns Promise<UpdateNetworkSecurityGroupResponse>

    UpdateNetworkSecurityGroupResponse

updateNetworkSecurityGroupSecurityRules

updatePrivateIp

  • 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 {@link #updateVnic(UpdateVnicRequest) updateVnic}.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdatePrivateIp API.

    Parameters

    Returns Promise<UpdatePrivateIpResponse>

    UpdatePrivateIpResponse

updatePublicIp

  • 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 {@link #createPublicIp(CreatePublicIpRequest) createPublicIp}. * 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 {@link #deletePublicIp(DeletePublicIpRequest) deletePublicIp}, which unassigns and deletes the ephemeral public IP.

    *Note:** If a public IP is assigned to a secondary private IP (see PrivateIp), and you move that secondary private IP to another VNIC, the public IP moves with it.

    *Note:** There's a limit to the number of PublicIp a VNIC or instance can have. If you try to move a reserved public IP to a VNIC or instance that has already reached its public IP limit, an error is returned. For information about the public IP limits, see [Public IP Addresses](https://docs.cloud.oracle.com/iaas/Content/Network/Tasks/managingpublicIPs.htm).

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdatePublicIp API.

    Parameters

    Returns Promise<UpdatePublicIpResponse>

    UpdatePublicIpResponse

updatePublicIpPool

updateRemotePeeringConnection

updateRouteTable

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateRouteTable API.

    Parameters

    Returns Promise<UpdateRouteTableResponse>

    UpdateRouteTableResponse

updateSecurityList

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSecurityList API.

    Parameters

    Returns Promise<UpdateSecurityListResponse>

    UpdateSecurityListResponse

updateServiceGateway

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateServiceGateway API.

    Parameters

    Returns Promise<UpdateServiceGatewayResponse>

    UpdateServiceGatewayResponse

updateSubnet

  • Updates the specified subnet.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSubnet API.

    Parameters

    Returns Promise<UpdateSubnetResponse>

    UpdateSubnetResponse

updateTunnelCpeDeviceConfig

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

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateTunnelCpeDeviceConfig API.

    Parameters

    Returns Promise<UpdateTunnelCpeDeviceConfigResponse>

    UpdateTunnelCpeDeviceConfigResponse

updateVcn

  • Updates the specified VCN.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVcn API.

    Parameters

    Returns Promise<UpdateVcnResponse>

    UpdateVcnResponse

updateVirtualCircuit

  • 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 {@link #updateVirtualCircuitDetails(UpdateVirtualCircuitDetailsRequest) updateVirtualCircuitDetails} 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](https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/fastconnect.htm).

    To change the list of public IP prefixes for a public virtual circuit, use {@link #bulkAddVirtualCircuitPublicPrefixes(BulkAddVirtualCircuitPublicPrefixesRequest) bulkAddVirtualCircuitPublicPrefixes} and {@link #bulkDeleteVirtualCircuitPublicPrefixes(BulkDeleteVirtualCircuitPublicPrefixesRequest) bulkDeleteVirtualCircuitPublicPrefixes}. 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.

    This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVirtualCircuit API.

    Parameters

    Returns Promise<UpdateVirtualCircuitResponse>

    UpdateVirtualCircuitResponse

updateVlan

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVlan API.

    Parameters

    Returns Promise<UpdateVlanResponse>

    UpdateVlanResponse

updateVnic

  • Updates the specified VNIC.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVnic API.

    Parameters

    Returns Promise<UpdateVnicResponse>

    UpdateVnicResponse

updateVtap

  • Updates the specified VTAP's display name or tags.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateVtap API.

    Parameters

    Returns Promise<UpdateVtapResponse>

    UpdateVtapResponse

upgradeDrg

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpgradeDrg API.

    Parameters

    Returns Promise<UpgradeDrgResponse>

    UpgradeDrgResponse

validateByoipRange

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

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ValidateByoipRange API.

    Parameters

    Returns Promise<ValidateByoipRangeResponse>

    ValidateByoipRangeResponse

withdrawByoipRange

  • Withdraws BGP route advertisement for the BYOIP CIDR block.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use WithdrawByoipRange API.

    Parameters

    Returns Promise<WithdrawByoipRangeResponse>

    WithdrawByoipRangeResponse