@Generated(value="OracleSDKGenerator", comments="API Version: 20160918") public class VirtualNetworkClient extends BaseSyncClient implements VirtualNetwork
Modifier and Type | Class and Description |
---|---|
static class |
VirtualNetworkClient.Builder
Builder class for this client.
|
Modifier and Type | Field and Description |
---|---|
String |
clientCommonLibraryVersion
Compatible SDK version, provided by the codegen.
|
protected ExecutorService |
executorService |
Optional<String> |
minimumClientCommonLibraryVersionFromClient
Minimum compatible SDK version, maybe provided by the codegen.
|
static Service |
SERVICE
Service instance for VirtualNetwork.
|
Constructor and Description |
---|
VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory)
Deprecated.
Use the
builder instead. |
VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators)
Deprecated.
Use the
builder instead. |
VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint)
Deprecated.
Use the
builder instead. |
VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator,
RequestSignerFactory defaultRequestSignerFactory,
Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories,
List<ClientConfigurator> additionalClientConfigurators,
String endpoint,
ExecutorService executorService)
Deprecated.
Use the
builder instead. |
VirtualNetworkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
Deprecated.
Use the
builder instead. |
VirtualNetworkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration)
Deprecated.
Use the
builder instead. |
VirtualNetworkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider,
ClientConfiguration configuration,
ClientConfigurator clientConfigurator)
Deprecated.
Use the
builder instead. |
clientCall
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getEndpoint, refreshClient, setEndpoint, useRealmSpecificEndpointTemplate
close
public static final Service SERVICE
Service instance for VirtualNetwork.
protected final ExecutorService executorService
public final String clientCommonLibraryVersion
@Deprecated public VirtualNetworkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)@Deprecated public VirtualNetworkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
@Deprecated public VirtualNetworkClient(BasicAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
@Deprecated public VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
@Deprecated public VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
@Deprecated public VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
@Deprecated public VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
@Deprecated public VirtualNetworkClient(AbstractAuthenticationDetailsProvider authenticationDetailsProvider, ClientConfiguration configuration, ClientConfigurator clientConfigurator, RequestSignerFactory defaultRequestSignerFactory, Map<SigningStrategy,RequestSignerFactory> signingStrategyRequestSignerFactories, List<ClientConfigurator> additionalClientConfigurators, String endpoint, ExecutorService executorService)
builder
instead.Create a new client instance.
authenticationDetailsProvider
- The authentication details (see VirtualNetworkClient.Builder.build(com.oracle.bmc.auth.AbstractAuthenticationDetailsProvider)
)configuration
- ClientBuilderBase.configuration
clientConfigurator
- ClientBuilderBase.clientConfigurator(com.oracle.bmc.http.ClientConfigurator)
defaultRequestSignerFactory
- ClientBuilderBase.requestSignerFactory
additionalClientConfigurators
- ClientBuilderBase.additionalClientConfigurators
endpoint
- ClientBuilderBase.endpoint(java.lang.String)
signingStrategyRequestSignerFactories
- ClientBuilderBase.signingStrategyRequestSignerFactories
executorService
- VirtualNetworkClient.Builder.executorService
public static VirtualNetworkClient.Builder builder()
Create a builder for this client.
public void setRegion(Region region)
VirtualNetwork
Sets the region to call (ex, Region.US_PHOENIX_1).
Note, this will call setEndpoint
after resolving the
endpoint. If the service is not available in this Region, however, an
IllegalArgumentException will be raised.
setRegion
in interface VirtualNetwork
region
- The region of the service.public void setRegion(String regionId)
VirtualNetwork
Sets the region to call (ex, ‘us-phoenix-1’).
Note, this will first try to map the region ID to a known Region and call setRegion
.
If no known Region could be determined, it will create an endpoint based on the default
endpoint format (Region.formatDefaultRegionEndpoint(Service, String)
and then call setEndpoint
.
setRegion
in interface VirtualNetwork
regionId
- The public region ID.public AddDrgRouteDistributionStatementsResponse addDrgRouteDistributionStatements(AddDrgRouteDistributionStatementsRequest request)
VirtualNetwork
Adds one or more route distribution statements to the specified route distribution.
addDrgRouteDistributionStatements
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AddDrgRouteRulesResponse addDrgRouteRules(AddDrgRouteRulesRequest request)
VirtualNetwork
Adds one or more static route rules to the specified DRG route table.
addDrgRouteRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AddIpv6SubnetCidrResponse addIpv6SubnetCidr(AddIpv6SubnetCidrRequest request)
VirtualNetwork
Add an IPv6 prefix to a subnet.
addIpv6SubnetCidr
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AddIpv6VcnCidrResponse addIpv6VcnCidr(AddIpv6VcnCidrRequest request)
VirtualNetwork
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.
addIpv6VcnCidr
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AddNetworkSecurityGroupSecurityRulesResponse addNetworkSecurityGroupSecurityRules(AddNetworkSecurityGroupSecurityRulesRequest request)
VirtualNetwork
Adds up to 25 security rules to the specified network security group. Adding more than 25 rules requires multiple operations.
addNetworkSecurityGroupSecurityRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AddPublicIpPoolCapacityResponse addPublicIpPoolCapacity(AddPublicIpPoolCapacityRequest request)
VirtualNetwork
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.
addPublicIpPoolCapacity
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AddVcnCidrResponse addVcnCidr(AddVcnCidrRequest request)
VirtualNetwork
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.
addVcnCidr
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AdvertiseByoipRangeResponse advertiseByoipRange(AdvertiseByoipRangeRequest request)
VirtualNetwork
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.
advertiseByoipRange
in interface VirtualNetwork
request
- The request object containing the details to sendpublic AttachServiceIdResponse attachServiceId(AttachServiceIdRequest request)
VirtualNetwork
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 updateServiceGateway
, which replaces the
entire existing list of enabled `Service` objects with the list that you provide in the
`Update` call.
attachServiceId
in interface VirtualNetwork
request
- The request object containing the details to sendpublic BulkAddVirtualCircuitPublicPrefixesResponse bulkAddVirtualCircuitPublicPrefixes(BulkAddVirtualCircuitPublicPrefixesRequest request)
VirtualNetwork
Adds one or more customer public IP prefixes to the specified public virtual circuit. Use
this operation (and not 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.
bulkAddVirtualCircuitPublicPrefixes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic BulkDeleteVirtualCircuitPublicPrefixesResponse bulkDeleteVirtualCircuitPublicPrefixes(BulkDeleteVirtualCircuitPublicPrefixesRequest request)
VirtualNetwork
Removes one or more customer public IP prefixes from the specified public virtual circuit.
Use this operation (and not 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.
bulkDeleteVirtualCircuitPublicPrefixes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeByoipRangeCompartmentResponse changeByoipRangeCompartment(ChangeByoipRangeCompartmentRequest request)
VirtualNetwork
Moves a BYOIP CIDR block to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeByoipRangeCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeCaptureFilterCompartmentResponse changeCaptureFilterCompartment(ChangeCaptureFilterCompartmentRequest request)
VirtualNetwork
Moves a capture filter to a new compartment in the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeCaptureFilterCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeCpeCompartmentResponse changeCpeCompartment(ChangeCpeCompartmentRequest request)
VirtualNetwork
Moves a CPE object into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeCpeCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeCrossConnectCompartmentResponse changeCrossConnectCompartment(ChangeCrossConnectCompartmentRequest request)
VirtualNetwork
Moves a cross-connect into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeCrossConnectCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeCrossConnectGroupCompartmentResponse changeCrossConnectGroupCompartment(ChangeCrossConnectGroupCompartmentRequest request)
VirtualNetwork
Moves a cross-connect group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeCrossConnectGroupCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeDhcpOptionsCompartmentResponse changeDhcpOptionsCompartment(ChangeDhcpOptionsCompartmentRequest request)
VirtualNetwork
Moves a set of DHCP options into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeDhcpOptionsCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeDrgCompartmentResponse changeDrgCompartment(ChangeDrgCompartmentRequest request)
VirtualNetwork
Moves a DRG into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeDrgCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeIPSecConnectionCompartmentResponse changeIPSecConnectionCompartment(ChangeIPSecConnectionCompartmentRequest request)
VirtualNetwork
Moves an IPSec connection into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeIPSecConnectionCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeInternetGatewayCompartmentResponse changeInternetGatewayCompartment(ChangeInternetGatewayCompartmentRequest request)
VirtualNetwork
Moves an internet gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeInternetGatewayCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeLocalPeeringGatewayCompartmentResponse changeLocalPeeringGatewayCompartment(ChangeLocalPeeringGatewayCompartmentRequest request)
VirtualNetwork
Moves a local peering gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeLocalPeeringGatewayCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeNatGatewayCompartmentResponse changeNatGatewayCompartment(ChangeNatGatewayCompartmentRequest request)
VirtualNetwork
Moves a NAT gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeNatGatewayCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeNetworkSecurityGroupCompartmentResponse changeNetworkSecurityGroupCompartment(ChangeNetworkSecurityGroupCompartmentRequest request)
VirtualNetwork
Moves a network security group into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeNetworkSecurityGroupCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangePublicIpCompartmentResponse changePublicIpCompartment(ChangePublicIpCompartmentRequest request)
VirtualNetwork
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.
changePublicIpCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangePublicIpPoolCompartmentResponse changePublicIpPoolCompartment(ChangePublicIpPoolCompartmentRequest request)
VirtualNetwork
Moves a public IP pool to a different compartment. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changePublicIpPoolCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeRemotePeeringConnectionCompartmentResponse changeRemotePeeringConnectionCompartment(ChangeRemotePeeringConnectionCompartmentRequest request)
VirtualNetwork
Moves a remote peering connection (RPC) into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeRemotePeeringConnectionCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeRouteTableCompartmentResponse changeRouteTableCompartment(ChangeRouteTableCompartmentRequest request)
VirtualNetwork
Moves a route table into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeRouteTableCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeSecurityListCompartmentResponse changeSecurityListCompartment(ChangeSecurityListCompartmentRequest request)
VirtualNetwork
Moves a security list into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeSecurityListCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeServiceGatewayCompartmentResponse changeServiceGatewayCompartment(ChangeServiceGatewayCompartmentRequest request)
VirtualNetwork
Moves a service gateway into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeServiceGatewayCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeSubnetCompartmentResponse changeSubnetCompartment(ChangeSubnetCompartmentRequest request)
VirtualNetwork
Moves a subnet into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeSubnetCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeVcnCompartmentResponse changeVcnCompartment(ChangeVcnCompartmentRequest request)
VirtualNetwork
Moves a VCN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVcnCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeVirtualCircuitCompartmentResponse changeVirtualCircuitCompartment(ChangeVirtualCircuitCompartmentRequest request)
VirtualNetwork
Moves a virtual circuit into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVirtualCircuitCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeVlanCompartmentResponse changeVlanCompartment(ChangeVlanCompartmentRequest request)
VirtualNetwork
Moves a VLAN into a different compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVlanCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ChangeVtapCompartmentResponse changeVtapCompartment(ChangeVtapCompartmentRequest request)
VirtualNetwork
Moves a VTAP to a new compartment within the same tenancy. For information about moving resources between compartments, see Moving Resources to a Different Compartment.
changeVtapCompartment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ConnectLocalPeeringGatewaysResponse connectLocalPeeringGateways(ConnectLocalPeeringGatewaysRequest request)
VirtualNetwork
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).
connectLocalPeeringGateways
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ConnectRemotePeeringConnectionsResponse connectRemotePeeringConnections(ConnectRemotePeeringConnectionsRequest request)
VirtualNetwork
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).
connectRemotePeeringConnections
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateByoipRangeResponse createByoipRange(CreateByoipRangeRequest request)
VirtualNetwork
Creates a subrange of the BYOIP CIDR block.
createByoipRange
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateCaptureFilterResponse createCaptureFilter(CreateCaptureFilterRequest request)
VirtualNetwork
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.
createCaptureFilter
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateCpeResponse createCpe(CreateCpeRequest request)
VirtualNetwork
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.
createCpe
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateCrossConnectResponse createCrossConnect(CreateCrossConnectRequest request)
VirtualNetwork
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.
createCrossConnect
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateCrossConnectGroupResponse createCrossConnectGroup(CreateCrossConnectGroupRequest request)
VirtualNetwork
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.
createCrossConnectGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateDhcpOptionsResponse createDhcpOptions(CreateDhcpOptionsRequest request)
VirtualNetwork
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.
createDhcpOptions
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateDrgResponse createDrg(CreateDrgRequest request)
VirtualNetwork
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.
createDrg
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateDrgAttachmentResponse createDrgAttachment(CreateDrgAttachmentRequest request)
VirtualNetwork
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).
createDrgAttachment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateDrgRouteDistributionResponse createDrgRouteDistribution(CreateDrgRouteDistributionRequest request)
VirtualNetwork
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.
createDrgRouteDistribution
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateDrgRouteTableResponse createDrgRouteTable(CreateDrgRouteTableRequest request)
VirtualNetwork
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.
createDrgRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateIPSecConnectionResponse createIPSecConnection(CreateIPSecConnectionRequest request)
VirtualNetwork
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).
createIPSecConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateInternetGatewayResponse createInternetGateway(CreateInternetGatewayRequest request)
VirtualNetwork
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
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 updateInternetGateway
to easily
disable/enable the gateway without changing the route rule.
createInternetGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateIpv6Response createIpv6(CreateIpv6Request request)
VirtualNetwork
Creates an IPv6 for the specified VNIC.
createIpv6
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateLocalPeeringGatewayResponse createLocalPeeringGateway(CreateLocalPeeringGatewayRequest request)
VirtualNetwork
Creates a new local peering gateway (LPG) for the specified VCN.
createLocalPeeringGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateNatGatewayResponse createNatGateway(CreateNatGatewayRequest request)
VirtualNetwork
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
.
createNatGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateNetworkSecurityGroupResponse createNetworkSecurityGroup(CreateNetworkSecurityGroupRequest request)
VirtualNetwork
Creates a new network security group for the specified VCN.
createNetworkSecurityGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreatePrivateIpResponse createPrivateIp(CreatePrivateIpRequest request)
VirtualNetwork
Creates a secondary private IP for the specified VNIC. For more information about secondary private IPs, see IP Addresses.
createPrivateIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreatePublicIpResponse createPublicIp(CreatePublicIpRequest request)
VirtualNetwork
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 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.
createPublicIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreatePublicIpPoolResponse createPublicIpPool(CreatePublicIpPoolRequest request)
VirtualNetwork
Creates a public IP pool.
createPublicIpPool
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateRemotePeeringConnectionResponse createRemotePeeringConnection(CreateRemotePeeringConnectionRequest request)
VirtualNetwork
Creates a new remote peering connection (RPC) for the specified DRG.
createRemotePeeringConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateRouteTableResponse createRouteTable(CreateRouteTableRequest request)
VirtualNetwork
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.
createRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateSecurityListResponse createSecurityList(CreateSecurityListRequest request)
VirtualNetwork
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.
createSecurityList
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateServiceGatewayResponse createServiceGateway(CreateServiceGatewayRequest request)
VirtualNetwork
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.
Use the listServices
operation to find service
CIDR labels available in the region.
createServiceGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateSubnetResponse createSubnet(CreateSubnetRequest request)
VirtualNetwork
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).
createSubnet
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateVcnResponse createVcn(CreateVcnRequest request)
VirtualNetwork
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).
createVcn
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateVirtualCircuitResponse createVirtualCircuit(CreateVirtualCircuitRequest request)
VirtualNetwork
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).
createVirtualCircuit
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateVlanResponse createVlan(CreateVlanRequest request)
VirtualNetwork
Creates a VLAN in the specified VCN and the specified compartment.
createVlan
in interface VirtualNetwork
request
- The request object containing the details to sendpublic CreateVtapResponse createVtap(CreateVtapRequest request)
VirtualNetwork
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.
createVtap
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteByoipRangeResponse deleteByoipRange(DeleteByoipRangeRequest request)
VirtualNetwork
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.
deleteByoipRange
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteCaptureFilterResponse deleteCaptureFilter(DeleteCaptureFilterRequest request)
VirtualNetwork
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.
deleteCaptureFilter
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteCpeResponse deleteCpe(DeleteCpeRequest request)
VirtualNetwork
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.
deleteCpe
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteCrossConnectResponse deleteCrossConnect(DeleteCrossConnectRequest request)
VirtualNetwork
Deletes the specified cross-connect. It must not be mapped to a VirtualCircuit
.
deleteCrossConnect
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteCrossConnectGroupResponse deleteCrossConnectGroup(DeleteCrossConnectGroupRequest request)
VirtualNetwork
Deletes the specified cross-connect group. It must not contain any cross-connects, and it
cannot be mapped to a VirtualCircuit
.
deleteCrossConnectGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteDhcpOptionsResponse deleteDhcpOptions(DeleteDhcpOptionsRequest request)
VirtualNetwork
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.
deleteDhcpOptions
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteDrgResponse deleteDrg(DeleteDrgRequest request)
VirtualNetwork
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.
deleteDrg
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteDrgAttachmentResponse deleteDrgAttachment(DeleteDrgAttachmentRequest request)
VirtualNetwork
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.
deleteDrgAttachment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteDrgRouteDistributionResponse deleteDrgRouteDistribution(DeleteDrgRouteDistributionRequest request)
VirtualNetwork
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.
deleteDrgRouteDistribution
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteDrgRouteTableResponse deleteDrgRouteTable(DeleteDrgRouteTableRequest request)
VirtualNetwork
Deletes the specified DRG route table. There must not be any DRG attachments assigned.
deleteDrgRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteIPSecConnectionResponse deleteIPSecConnection(DeleteIPSecConnectionRequest request)
VirtualNetwork
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 createIPSecConnection
.
This is an asynchronous operation. The connection's `lifecycleState` will change to TERMINATING temporarily until the connection is completely removed.
deleteIPSecConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteInternetGatewayResponse deleteInternetGateway(DeleteInternetGatewayRequest request)
VirtualNetwork
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.
deleteInternetGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteIpv6Response deleteIpv6(DeleteIpv6Request request)
VirtualNetwork
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.
deleteIpv6
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteLocalPeeringGatewayResponse deleteLocalPeeringGateway(DeleteLocalPeeringGatewayRequest request)
VirtualNetwork
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.
deleteLocalPeeringGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteNatGatewayResponse deleteNatGateway(DeleteNatGatewayRequest request)
VirtualNetwork
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.
deleteNatGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteNetworkSecurityGroupResponse deleteNetworkSecurityGroup(DeleteNetworkSecurityGroupRequest request)
VirtualNetwork
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 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).
deleteNetworkSecurityGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeletePrivateIpResponse deletePrivateIp(DeletePrivateIpRequest request)
VirtualNetwork
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.
deletePrivateIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeletePublicIpResponse deletePublicIp(DeletePublicIpRequest request)
VirtualNetwork
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 updatePublicIp
.
deletePublicIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeletePublicIpPoolResponse deletePublicIpPool(DeletePublicIpPoolRequest request)
VirtualNetwork
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.
deletePublicIpPool
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteRemotePeeringConnectionResponse deleteRemotePeeringConnection(DeleteRemotePeeringConnectionRequest request)
VirtualNetwork
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.
deleteRemotePeeringConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteRouteTableResponse deleteRouteTable(DeleteRouteTableRequest request)
VirtualNetwork
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.
deleteRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteSecurityListResponse deleteSecurityList(DeleteSecurityListRequest request)
VirtualNetwork
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.
deleteSecurityList
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteServiceGatewayResponse deleteServiceGateway(DeleteServiceGatewayRequest request)
VirtualNetwork
Deletes the specified service gateway. There must not be a route table that lists the service gateway as a target.
deleteServiceGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteSubnetResponse deleteSubnet(DeleteSubnetRequest request)
VirtualNetwork
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.
deleteSubnet
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteVcnResponse deleteVcn(DeleteVcnRequest request)
VirtualNetwork
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.
deleteVcn
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteVirtualCircuitResponse deleteVirtualCircuit(DeleteVirtualCircuitRequest request)
VirtualNetwork
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.
deleteVirtualCircuit
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteVlanResponse deleteVlan(DeleteVlanRequest request)
VirtualNetwork
Deletes the specified VLAN, but only if there are no VNICs in the VLAN.
deleteVlan
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DeleteVtapResponse deleteVtap(DeleteVtapRequest request)
VirtualNetwork
Deletes the specified VTAP. This is an asynchronous operation. The VTAP’s lifecycleState
will change to TERMINATING temporarily until the VTAP is completely removed.
deleteVtap
in interface VirtualNetwork
request
- The request object containing the details to sendpublic DetachServiceIdResponse detachServiceId(DetachServiceIdRequest request)
VirtualNetwork
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 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.
detachServiceId
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetAllDrgAttachmentsResponse getAllDrgAttachments(GetAllDrgAttachmentsRequest request)
VirtualNetwork
Returns a complete list of DRG attachments that belong to a particular DRG.
getAllDrgAttachments
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetAllowedIkeIPSecParametersResponse getAllowedIkeIPSecParameters(GetAllowedIkeIPSecParametersRequest request)
VirtualNetwork
The parameters allowed for IKE IPSec tunnels.
getAllowedIkeIPSecParameters
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetByoipRangeResponse getByoipRange(GetByoipRangeRequest request)
VirtualNetwork
Gets the ByoipRange
resource. You must specify the
OCID.
getByoipRange
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCaptureFilterResponse getCaptureFilter(GetCaptureFilterRequest request)
VirtualNetwork
Gets information about the specified VTAP capture filter.
getCaptureFilter
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCpeResponse getCpe(GetCpeRequest request)
VirtualNetwork
Gets the specified CPE’s information.
getCpe
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCpeDeviceConfigContentResponse getCpeDeviceConfigContent(GetCpeDeviceConfigContentRequest request)
VirtualNetwork
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 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:
getIpsecCpeDeviceConfigContent
returns CPE configuration content for all IPSec tunnels in a
single IPSec connection. * getTunnelCpeDeviceConfigContent
returns CPE configuration content for a specific IPSec
tunnel in an IPSec connection.
getCpeDeviceConfigContent
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCpeDeviceShapeResponse getCpeDeviceShape(GetCpeDeviceShapeRequest request)
VirtualNetwork
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 updateTunnelCpeDeviceConfig
). The service merges the answers with a template of other
information for the CPE device type. The following operations return the merged content:
getCpeDeviceConfigContent
* getIpsecCpeDeviceConfigContent
* getTunnelCpeDeviceConfigContent
getCpeDeviceShape
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCrossConnectResponse getCrossConnect(GetCrossConnectRequest request)
VirtualNetwork
Gets the specified cross-connect’s information.
getCrossConnect
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCrossConnectGroupResponse getCrossConnectGroup(GetCrossConnectGroupRequest request)
VirtualNetwork
Gets the specified cross-connect group’s information.
getCrossConnectGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCrossConnectLetterOfAuthorityResponse getCrossConnectLetterOfAuthority(GetCrossConnectLetterOfAuthorityRequest request)
VirtualNetwork
Gets the Letter of Authority for the specified cross-connect.
getCrossConnectLetterOfAuthority
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetCrossConnectStatusResponse getCrossConnectStatus(GetCrossConnectStatusRequest request)
VirtualNetwork
Gets the status of the specified cross-connect.
getCrossConnectStatus
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetDhcpOptionsResponse getDhcpOptions(GetDhcpOptionsRequest request)
VirtualNetwork
Gets the specified set of DHCP options.
getDhcpOptions
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetDrgResponse getDrg(GetDrgRequest request)
VirtualNetwork
Gets the specified DRG’s information.
getDrg
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetDrgAttachmentResponse getDrgAttachment(GetDrgAttachmentRequest request)
VirtualNetwork
Gets the DrgAttachment
resource.
getDrgAttachment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetDrgRedundancyStatusResponse getDrgRedundancyStatus(GetDrgRedundancyStatusRequest request)
VirtualNetwork
Gets the redundancy status for the specified DRG. For more information, see Redundancy Remedies.
getDrgRedundancyStatus
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetDrgRouteDistributionResponse getDrgRouteDistribution(GetDrgRouteDistributionRequest request)
VirtualNetwork
Gets the specified route distribution’s information.
getDrgRouteDistribution
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetDrgRouteTableResponse getDrgRouteTable(GetDrgRouteTableRequest request)
VirtualNetwork
Gets the specified DRG route table’s information.
getDrgRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetFastConnectProviderServiceResponse getFastConnectProviderService(GetFastConnectProviderServiceRequest request)
VirtualNetwork
Gets the specified provider service. For more information, see FastConnect Overview.
getFastConnectProviderService
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetFastConnectProviderServiceKeyResponse getFastConnectProviderServiceKey(GetFastConnectProviderServiceKeyRequest request)
VirtualNetwork
Gets the specified provider service key’s information. Use this operation to validate a provider service key. An invalid key returns a 404 error.
getFastConnectProviderServiceKey
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIPSecConnectionResponse getIPSecConnection(GetIPSecConnectionRequest request)
VirtualNetwork
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
getIPSecConnectionTunnel
.
getIPSecConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIPSecConnectionDeviceConfigResponse getIPSecConnectionDeviceConfig(GetIPSecConnectionDeviceConfigRequest request)
VirtualNetwork
Deprecated. To get tunnel information, instead use:
getIPSecConnectionTunnel
* getIPSecConnectionTunnelSharedSecret
getIPSecConnectionDeviceConfig
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIPSecConnectionDeviceStatusResponse getIPSecConnectionDeviceStatus(GetIPSecConnectionDeviceStatusRequest request)
VirtualNetwork
Deprecated. To get the tunnel status, instead use getIPSecConnectionTunnel
.
getIPSecConnectionDeviceStatus
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIPSecConnectionTunnelResponse getIPSecConnectionTunnel(GetIPSecConnectionTunnelRequest request)
VirtualNetwork
Gets the specified tunnel’s information. The resulting object does not include the tunnel’s
shared secret (pre-shared key). To retrieve that, use getIPSecConnectionTunnelSharedSecret
.
getIPSecConnectionTunnel
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIPSecConnectionTunnelErrorResponse getIPSecConnectionTunnelError(GetIPSecConnectionTunnelErrorRequest request)
VirtualNetwork
Gets the identified error for the specified IPSec tunnel ID.
getIPSecConnectionTunnelError
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIPSecConnectionTunnelSharedSecretResponse getIPSecConnectionTunnelSharedSecret(GetIPSecConnectionTunnelSharedSecretRequest request)
VirtualNetwork
Gets the specified tunnel’s shared secret (pre-shared key). To get other information about
the tunnel, use getIPSecConnectionTunnel
.
getIPSecConnectionTunnelSharedSecret
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetInternetGatewayResponse getInternetGateway(GetInternetGatewayRequest request)
VirtualNetwork
Gets the specified internet gateway’s information.
getInternetGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIpsecCpeDeviceConfigContentResponse getIpsecCpeDeviceConfigContent(GetIpsecCpeDeviceConfigContentRequest request)
VirtualNetwork
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 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:
getTunnelCpeDeviceConfigContent
returns CPE configuration content for a specific tunnel
within an IPSec connection. * getCpeDeviceConfigContent
returns CPE configuration content for *all* IPSec connections that use a specific CPE.
getIpsecCpeDeviceConfigContent
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetIpv6Response getIpv6(GetIpv6Request request)
VirtualNetwork
Gets the specified IPv6. You must specify the object’s
OCID.
Alternatively, you can get the object by using listIpv6s
with the IPv6 address (for example, 2001:0db8:0123:1111:98fe:dcba:9876:4321) and subnet
OCID.
getIpv6
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetLocalPeeringGatewayResponse getLocalPeeringGateway(GetLocalPeeringGatewayRequest request)
VirtualNetwork
Gets the specified local peering gateway’s information.
getLocalPeeringGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetNatGatewayResponse getNatGateway(GetNatGatewayRequest request)
VirtualNetwork
Gets the specified NAT gateway’s information.
getNatGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetNetworkSecurityGroupResponse getNetworkSecurityGroup(GetNetworkSecurityGroupRequest request)
VirtualNetwork
Gets the specified network security group’s information.
To list the VNICs in an NSG, see listNetworkSecurityGroupVnics
.
To list the security rules in an NSG, see listNetworkSecurityGroupSecurityRules
.
getNetworkSecurityGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetNetworkingTopologyResponse getNetworkingTopology(GetNetworkingTopologyRequest request)
VirtualNetwork
Gets a virtual networking topology for the current region.
getNetworkingTopology
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetPrivateIpResponse getPrivateIp(GetPrivateIpRequest request)
VirtualNetwork
Gets the specified private IP. You must specify the object’s
OCID.
Alternatively, you can get the object by using listPrivateIps
with the private IP address (for example, 10.0.3.3) and subnet
OCID.
getPrivateIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetPublicIpResponse getPublicIp(GetPublicIpRequest request)
VirtualNetwork
Gets the specified public IP. You must specify the object’s OCID.
Alternatively, you can get the object by using getPublicIpByIpAddress
with the
public IP address (for example, 203.0.113.2).
Or you can use 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.
getPublicIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetPublicIpByIpAddressResponse getPublicIpByIpAddress(GetPublicIpByIpAddressRequest request)
VirtualNetwork
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.
getPublicIpByIpAddress
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetPublicIpByPrivateIpIdResponse getPublicIpByPrivateIpId(GetPublicIpByPrivateIpIdRequest request)
VirtualNetwork
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 getPublicIp
or 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.
getPublicIpByPrivateIpId
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetPublicIpPoolResponse getPublicIpPool(GetPublicIpPoolRequest request)
VirtualNetwork
Gets the specified PublicIpPool
object. You must specify the object’s
OCID.
getPublicIpPool
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetRemotePeeringConnectionResponse getRemotePeeringConnection(GetRemotePeeringConnectionRequest request)
VirtualNetwork
Get the specified remote peering connection’s information.
getRemotePeeringConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetResourceIpInventoryResponse getResourceIpInventory(GetResourceIpInventoryRequest request)
VirtualNetwork
Gets the IpInventory
resource.
getResourceIpInventory
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetRouteTableResponse getRouteTable(GetRouteTableRequest request)
VirtualNetwork
Gets the specified route table’s information.
getRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetSecurityListResponse getSecurityList(GetSecurityListRequest request)
VirtualNetwork
Gets the specified security list’s information.
getSecurityList
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetServiceResponse getService(GetServiceRequest request)
VirtualNetwork
Gets the specified Service
object.
getService
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetServiceGatewayResponse getServiceGateway(GetServiceGatewayRequest request)
VirtualNetwork
Gets the specified service gateway’s information.
getServiceGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetSubnetResponse getSubnet(GetSubnetRequest request)
VirtualNetwork
Gets the specified subnet’s information.
getSubnet
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetSubnetCidrUtilizationResponse getSubnetCidrUtilization(GetSubnetCidrUtilizationRequest request)
VirtualNetwork
Gets the CIDR utilization data of the specified subnet. Specify the OCID.
getSubnetCidrUtilization
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetSubnetIpInventoryResponse getSubnetIpInventory(GetSubnetIpInventoryRequest request)
VirtualNetwork
Gets the IP Inventory data of the specified subnet. Specify the OCID.
getSubnetIpInventory
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetSubnetTopologyResponse getSubnetTopology(GetSubnetTopologyRequest request)
VirtualNetwork
Gets a topology for a given subnet.
getSubnetTopology
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetTunnelCpeDeviceConfigResponse getTunnelCpeDeviceConfig(GetTunnelCpeDeviceConfigRequest request)
VirtualNetwork
Gets the set of CPE configuration answers for the tunnel, which the customer provided in
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 getTunnelCpeDeviceConfigContent
.
getTunnelCpeDeviceConfig
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetTunnelCpeDeviceConfigContentResponse getTunnelCpeDeviceConfigContent(GetTunnelCpeDeviceConfigContentRequest request)
VirtualNetwork
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 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:
getIpsecCpeDeviceConfigContent
returns CPE configuration content for all tunnels in a single
IPSec connection. * getCpeDeviceConfigContent
returns CPE configuration content for *all* IPSec connections that
use a specific CPE.
getTunnelCpeDeviceConfigContent
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetUpgradeStatusResponse getUpgradeStatus(GetUpgradeStatusRequest request)
VirtualNetwork
Returns the DRG upgrade status. The status can be not updated, in progress, or updated. Also indicates how much of the upgrade is completed.
getUpgradeStatus
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVcnResponse getVcn(GetVcnRequest request)
VirtualNetwork
Gets the specified VCN’s information.
getVcn
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVcnDnsResolverAssociationResponse getVcnDnsResolverAssociation(GetVcnDnsResolverAssociationRequest request)
VirtualNetwork
Get the associated DNS resolver information with a vcn
getVcnDnsResolverAssociation
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVcnOverlapResponse getVcnOverlap(GetVcnOverlapRequest request)
VirtualNetwork
Gets the CIDR overlap information of the specified VCN in selected compartments. Specify the OCID.
getVcnOverlap
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVcnTopologyResponse getVcnTopology(GetVcnTopologyRequest request)
VirtualNetwork
Gets a virtual network topology for a given VCN.
getVcnTopology
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVirtualCircuitResponse getVirtualCircuit(GetVirtualCircuitRequest request)
VirtualNetwork
Gets the specified virtual circuit’s information.
getVirtualCircuit
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVlanResponse getVlan(GetVlanRequest request)
VirtualNetwork
Gets the specified VLAN’s information.
getVlan
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVnicResponse getVnic(GetVnicRequest request)
VirtualNetwork
Gets the information for the specified virtual network interface card (VNIC). You can get the
VNIC OCID from
the listVnicAttachments
operation.
getVnic
in interface VirtualNetwork
request
- The request object containing the details to sendpublic GetVtapResponse getVtap(GetVtapRequest request)
VirtualNetwork
Gets the specified Vtap
resource.
getVtap
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListAllowedPeerRegionsForRemotePeeringResponse listAllowedPeerRegionsForRemotePeering(ListAllowedPeerRegionsForRemotePeeringRequest request)
VirtualNetwork
Lists the regions that support remote VCN peering (which is peering across regions). For more information, see VCN Peering.
listAllowedPeerRegionsForRemotePeering
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListByoipAllocatedRangesResponse listByoipAllocatedRanges(ListByoipAllocatedRangesRequest request)
VirtualNetwork
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.
listByoipAllocatedRanges
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListByoipRangesResponse listByoipRanges(ListByoipRangesRequest request)
VirtualNetwork
Lists the ByoipRange
resources in the specified compartment. You can filter the list using
query parameters.
listByoipRanges
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCaptureFiltersResponse listCaptureFilters(ListCaptureFiltersRequest request)
VirtualNetwork
Lists the capture filters in the specified compartment.
listCaptureFilters
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCpeDeviceShapesResponse listCpeDeviceShapes(ListCpeDeviceShapesRequest request)
VirtualNetwork
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:
getCpeDeviceConfigContent
* getIpsecCpeDeviceConfigContent
* getTunnelCpeDeviceConfigContent
listCpeDeviceShapes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCpesResponse listCpes(ListCpesRequest request)
VirtualNetwork
Lists the customer-premises equipment objects (CPEs) in the specified compartment.
listCpes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCrossConnectGroupsResponse listCrossConnectGroups(ListCrossConnectGroupsRequest request)
VirtualNetwork
Lists the cross-connect groups in the specified compartment.
listCrossConnectGroups
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCrossConnectLocationsResponse listCrossConnectLocations(ListCrossConnectLocationsRequest request)
VirtualNetwork
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.
listCrossConnectLocations
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCrossConnectMappingsResponse listCrossConnectMappings(ListCrossConnectMappingsRequest request)
VirtualNetwork
Lists the Cross Connect mapping Details for the specified virtual circuit.
listCrossConnectMappings
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCrossConnectsResponse listCrossConnects(ListCrossConnectsRequest request)
VirtualNetwork
Lists the cross-connects in the specified compartment. You can filter the list by specifying the OCID of a cross-connect group.
listCrossConnects
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListCrossconnectPortSpeedShapesResponse listCrossconnectPortSpeedShapes(ListCrossconnectPortSpeedShapesRequest request)
VirtualNetwork
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.
listCrossconnectPortSpeedShapes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListDhcpOptionsResponse listDhcpOptions(ListDhcpOptionsRequest request)
VirtualNetwork
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.
listDhcpOptions
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListDrgAttachmentsResponse listDrgAttachments(ListDrgAttachmentsRequest request)
VirtualNetwork
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.
listDrgAttachments
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListDrgRouteDistributionStatementsResponse listDrgRouteDistributionStatements(ListDrgRouteDistributionStatementsRequest request)
VirtualNetwork
Lists the statements for the specified route distribution.
listDrgRouteDistributionStatements
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListDrgRouteDistributionsResponse listDrgRouteDistributions(ListDrgRouteDistributionsRequest request)
VirtualNetwork
Lists the route distributions in the specified DRG.
To retrieve the statements in a distribution, use the ListDrgRouteDistributionStatements operation.
listDrgRouteDistributions
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListDrgRouteRulesResponse listDrgRouteRules(ListDrgRouteRulesRequest request)
VirtualNetwork
Lists the route rules in the specified DRG route table.
listDrgRouteRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListDrgRouteTablesResponse listDrgRouteTables(ListDrgRouteTablesRequest request)
VirtualNetwork
Lists the DRG route tables for the specified DRG.
Use the `ListDrgRouteRules` operation to retrieve the route rules in a table.
listDrgRouteTables
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListDrgsResponse listDrgs(ListDrgsRequest request)
VirtualNetwork
Lists the DRGs in the specified compartment.
listDrgs
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListFastConnectProviderServicesResponse listFastConnectProviderServices(ListFastConnectProviderServicesRequest request)
VirtualNetwork
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).
listFastConnectProviderServices
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListFastConnectProviderVirtualCircuitBandwidthShapesResponse listFastConnectProviderVirtualCircuitBandwidthShapes(ListFastConnectProviderVirtualCircuitBandwidthShapesRequest request)
VirtualNetwork
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).
listFastConnectProviderVirtualCircuitBandwidthShapes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListIPSecConnectionTunnelRoutesResponse listIPSecConnectionTunnelRoutes(ListIPSecConnectionTunnelRoutesRequest request)
VirtualNetwork
The routes advertised to the on-premises network and the routes received from the on-premises network.
listIPSecConnectionTunnelRoutes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListIPSecConnectionTunnelSecurityAssociationsResponse listIPSecConnectionTunnelSecurityAssociations(ListIPSecConnectionTunnelSecurityAssociationsRequest request)
VirtualNetwork
Lists the tunnel security associations information for the specified IPSec tunnel ID.
listIPSecConnectionTunnelSecurityAssociations
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListIPSecConnectionTunnelsResponse listIPSecConnectionTunnels(ListIPSecConnectionTunnelsRequest request)
VirtualNetwork
Lists the tunnel information for the specified IPSec connection.
listIPSecConnectionTunnels
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListIPSecConnectionsResponse listIPSecConnections(ListIPSecConnectionsRequest request)
VirtualNetwork
Lists the IPSec connections for the specified compartment. You can filter the results by DRG or CPE.
listIPSecConnections
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListInternetGatewaysResponse listInternetGateways(ListInternetGatewaysRequest request)
VirtualNetwork
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.
listInternetGateways
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListIpInventoryResponse listIpInventory(ListIpInventoryRequest request)
VirtualNetwork
Lists the IP Inventory information in the selected compartments.
listIpInventory
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListIpv6sResponse listIpv6s(ListIpv6sRequest request)
VirtualNetwork
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, getIpv6
requires the
[OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm).
listIpv6s
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListLocalPeeringGatewaysResponse listLocalPeeringGateways(ListLocalPeeringGatewaysRequest request)
VirtualNetwork
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.
listLocalPeeringGateways
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListNatGatewaysResponse listNatGateways(ListNatGatewaysRequest request)
VirtualNetwork
Lists the NAT gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.
listNatGateways
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListNetworkSecurityGroupSecurityRulesResponse listNetworkSecurityGroupSecurityRules(ListNetworkSecurityGroupSecurityRulesRequest request)
VirtualNetwork
Lists the security rules in the specified network security group.
listNetworkSecurityGroupSecurityRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListNetworkSecurityGroupVnicsResponse listNetworkSecurityGroupVnics(ListNetworkSecurityGroupVnicsRequest request)
VirtualNetwork
Lists the VNICs in the specified network security group.
listNetworkSecurityGroupVnics
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListNetworkSecurityGroupsResponse listNetworkSecurityGroups(ListNetworkSecurityGroupsRequest request)
VirtualNetwork
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.
listNetworkSecurityGroups
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListPrivateIpsResponse listPrivateIps(ListPrivateIpsRequest request)
VirtualNetwork
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, 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
.
listPrivateIps
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListPublicIpPoolsResponse listPublicIpPools(ListPublicIpPoolsRequest request)
VirtualNetwork
Lists the public IP pools in the specified compartment. You can filter the list using query parameters.
listPublicIpPools
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListPublicIpsResponse listPublicIps(ListPublicIpsRequest request)
VirtualNetwork
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.
listPublicIps
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListRemotePeeringConnectionsResponse listRemotePeeringConnections(ListRemotePeeringConnectionsRequest request)
VirtualNetwork
Lists the remote peering connections (RPCs) for the specified DRG and compartment (the RPC’s compartment).
listRemotePeeringConnections
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListRouteTablesResponse listRouteTables(ListRouteTablesRequest request)
VirtualNetwork
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.
listRouteTables
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListSecurityListsResponse listSecurityLists(ListSecurityListsRequest request)
VirtualNetwork
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.
listSecurityLists
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListServiceGatewaysResponse listServiceGateways(ListServiceGatewaysRequest request)
VirtualNetwork
Lists the service gateways in the specified compartment. You may optionally specify a VCN OCID to filter the results by VCN.
listServiceGateways
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListServicesResponse listServices(ListServicesRequest request)
VirtualNetwork
Lists the available Service
objects that you can enable for a service gateway in this
region.
listServices
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListSubnetsResponse listSubnets(ListSubnetsRequest request)
VirtualNetwork
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.
listSubnets
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListVcnsResponse listVcns(ListVcnsRequest request)
VirtualNetwork
Lists the virtual cloud networks (VCNs) in the specified compartment.
listVcns
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListVirtualCircuitAssociatedTunnelsResponse listVirtualCircuitAssociatedTunnels(ListVirtualCircuitAssociatedTunnelsRequest request)
VirtualNetwork
Gets the specified virtual circuit’s associatedTunnelsInfo.
listVirtualCircuitAssociatedTunnels
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListVirtualCircuitBandwidthShapesResponse listVirtualCircuitBandwidthShapes(ListVirtualCircuitBandwidthShapesRequest request)
VirtualNetwork
The operation lists available bandwidth levels for virtual circuits. For the compartment ID, provide the OCID of your tenancy (the root compartment).
listVirtualCircuitBandwidthShapes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListVirtualCircuitPublicPrefixesResponse listVirtualCircuitPublicPrefixes(ListVirtualCircuitPublicPrefixesRequest request)
VirtualNetwork
Lists the public IP prefixes and their details for the specified public virtual circuit.
listVirtualCircuitPublicPrefixes
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListVirtualCircuitsResponse listVirtualCircuits(ListVirtualCircuitsRequest request)
VirtualNetwork
Lists the virtual circuits in the specified compartment.
listVirtualCircuits
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListVlansResponse listVlans(ListVlansRequest request)
VirtualNetwork
Lists the VLANs in the specified VCN and the specified compartment.
listVlans
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ListVtapsResponse listVtaps(ListVtapsRequest request)
VirtualNetwork
Lists the virtual test access points (VTAPs) in the specified compartment.
listVtaps
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ModifyVcnCidrResponse modifyVcnCidr(ModifyVcnCidrRequest request)
VirtualNetwork
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.
modifyVcnCidr
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveDrgRouteDistributionStatementsResponse removeDrgRouteDistributionStatements(RemoveDrgRouteDistributionStatementsRequest request)
VirtualNetwork
Removes one or more route distribution statements from the specified route distribution’s map.
removeDrgRouteDistributionStatements
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveDrgRouteRulesResponse removeDrgRouteRules(RemoveDrgRouteRulesRequest request)
VirtualNetwork
Removes one or more route rules from the specified DRG route table.
removeDrgRouteRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveExportDrgRouteDistributionResponse removeExportDrgRouteDistribution(RemoveExportDrgRouteDistributionRequest request)
VirtualNetwork
Removes the export route distribution from the DRG attachment so no routes are advertised to it.
removeExportDrgRouteDistribution
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveImportDrgRouteDistributionResponse removeImportDrgRouteDistribution(RemoveImportDrgRouteDistributionRequest request)
VirtualNetwork
Removes the import route distribution from the DRG route table so no routes are imported into it.
removeImportDrgRouteDistribution
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveIpv6SubnetCidrResponse removeIpv6SubnetCidr(RemoveIpv6SubnetCidrRequest request)
VirtualNetwork
Remove an IPv6 prefix from a subnet. At least one IPv6 CIDR should remain.
removeIpv6SubnetCidr
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveIpv6VcnCidrResponse removeIpv6VcnCidr(RemoveIpv6VcnCidrRequest request)
VirtualNetwork
Removing an existing IPv6 prefix from a VCN.
removeIpv6VcnCidr
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveNetworkSecurityGroupSecurityRulesResponse removeNetworkSecurityGroupSecurityRules(RemoveNetworkSecurityGroupSecurityRulesRequest request)
VirtualNetwork
Removes one or more security rules from the specified network security group.
removeNetworkSecurityGroupSecurityRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemovePublicIpPoolCapacityResponse removePublicIpPoolCapacity(RemovePublicIpPoolCapacityRequest request)
VirtualNetwork
Removes a CIDR block from the referenced public IP pool.
removePublicIpPoolCapacity
in interface VirtualNetwork
request
- The request object containing the details to sendpublic RemoveVcnCidrResponse removeVcnCidr(RemoveVcnCidrRequest request)
VirtualNetwork
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.
removeVcnCidr
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateByoipRangeResponse updateByoipRange(UpdateByoipRangeRequest request)
VirtualNetwork
Updates the tags or display name associated to the specified BYOIP CIDR block.
updateByoipRange
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateCaptureFilterResponse updateCaptureFilter(UpdateCaptureFilterRequest request)
VirtualNetwork
Updates the specified VTAP capture filter’s display name or tags.
updateCaptureFilter
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateCpeResponse updateCpe(UpdateCpeRequest request)
VirtualNetwork
Updates the specified CPE’s display name or tags. Avoid entering confidential information.
updateCpe
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateCrossConnectResponse updateCrossConnect(UpdateCrossConnectRequest request)
VirtualNetwork
Updates the specified cross-connect.
updateCrossConnect
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateCrossConnectGroupResponse updateCrossConnectGroup(UpdateCrossConnectGroupRequest request)
VirtualNetwork
Updates the specified cross-connect group’s display name. Avoid entering confidential information.
updateCrossConnectGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateDhcpOptionsResponse updateDhcpOptions(UpdateDhcpOptionsRequest request)
VirtualNetwork
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.
updateDhcpOptions
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateDrgResponse updateDrg(UpdateDrgRequest request)
VirtualNetwork
Updates the specified DRG’s display name or tags. Avoid entering confidential information.
updateDrg
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateDrgAttachmentResponse updateDrgAttachment(UpdateDrgAttachmentRequest request)
VirtualNetwork
Updates the display name and routing information for the specified DrgAttachment
. Avoid
entering confidential information.
updateDrgAttachment
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateDrgRouteDistributionResponse updateDrgRouteDistribution(UpdateDrgRouteDistributionRequest request)
VirtualNetwork
Updates the specified route distribution
updateDrgRouteDistribution
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateDrgRouteDistributionStatementsResponse updateDrgRouteDistributionStatements(UpdateDrgRouteDistributionStatementsRequest request)
VirtualNetwork
Updates one or more route distribution statements in the specified route distribution.
updateDrgRouteDistributionStatements
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateDrgRouteRulesResponse updateDrgRouteRules(UpdateDrgRouteRulesRequest request)
VirtualNetwork
Updates one or more route rules in the specified DRG route table.
updateDrgRouteRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateDrgRouteTableResponse updateDrgRouteTable(UpdateDrgRouteTableRequest request)
VirtualNetwork
Updates the specified DRG route table.
updateDrgRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateIPSecConnectionResponse updateIPSecConnection(UpdateIPSecConnectionRequest request)
VirtualNetwork
Updates the specified IPSec connection.
To update an individual IPSec tunnel's attributes, use updateIPSecConnectionTunnel
.
updateIPSecConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateIPSecConnectionTunnelResponse updateIPSecConnectionTunnel(UpdateIPSecConnectionTunnelRequest request)
VirtualNetwork
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 (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.
updateIPSecConnectionTunnel
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateIPSecConnectionTunnelSharedSecretResponse updateIPSecConnectionTunnelSharedSecret(UpdateIPSecConnectionTunnelSharedSecretRequest request)
VirtualNetwork
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.
updateIPSecConnectionTunnelSharedSecret
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateInternetGatewayResponse updateInternetGateway(UpdateInternetGatewayRequest request)
VirtualNetwork
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.
updateInternetGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateIpv6Response updateIpv6(UpdateIpv6Request request)
VirtualNetwork
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.
updateIpv6
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateLocalPeeringGatewayResponse updateLocalPeeringGateway(UpdateLocalPeeringGatewayRequest request)
VirtualNetwork
Updates the specified local peering gateway (LPG).
updateLocalPeeringGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateNatGatewayResponse updateNatGateway(UpdateNatGatewayRequest request)
VirtualNetwork
Updates the specified NAT gateway.
updateNatGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateNetworkSecurityGroupResponse updateNetworkSecurityGroup(UpdateNetworkSecurityGroupRequest request)
VirtualNetwork
Updates the specified network security group.
To add or remove an existing VNIC from the group, use 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 createVnicDetails
.
To add or remove security rules from the group, use addNetworkSecurityGroupSecurityRules
or removeNetworkSecurityGroupSecurityRules
.
To edit the contents of existing security rules in the group, use updateNetworkSecurityGroupSecurityRules
.
updateNetworkSecurityGroup
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateNetworkSecurityGroupSecurityRulesResponse updateNetworkSecurityGroupSecurityRules(UpdateNetworkSecurityGroupSecurityRulesRequest request)
VirtualNetwork
Updates one or more security rules in the specified network security group.
updateNetworkSecurityGroupSecurityRules
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdatePrivateIpResponse updatePrivateIp(UpdatePrivateIpRequest request)
VirtualNetwork
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 updateVnic
.
updatePrivateIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdatePublicIpResponse updatePublicIp(UpdatePublicIpRequest request)
VirtualNetwork
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 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 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).
updatePublicIp
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdatePublicIpPoolResponse updatePublicIpPool(UpdatePublicIpPoolRequest request)
VirtualNetwork
Updates the specified public IP pool.
updatePublicIpPool
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateRemotePeeringConnectionResponse updateRemotePeeringConnection(UpdateRemotePeeringConnectionRequest request)
VirtualNetwork
Updates the specified remote peering connection (RPC).
updateRemotePeeringConnection
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateRouteTableResponse updateRouteTable(UpdateRouteTableRequest request)
VirtualNetwork
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.
updateRouteTable
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateSecurityListResponse updateSecurityList(UpdateSecurityListRequest request)
VirtualNetwork
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.
updateSecurityList
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateServiceGatewayResponse updateServiceGateway(UpdateServiceGatewayRequest request)
VirtualNetwork
Updates the specified service gateway. The information you provide overwrites the existing attributes of the gateway.
updateServiceGateway
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateSubnetResponse updateSubnet(UpdateSubnetRequest request)
VirtualNetwork
Updates the specified subnet.
updateSubnet
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateTunnelCpeDeviceConfigResponse updateTunnelCpeDeviceConfig(UpdateTunnelCpeDeviceConfigRequest request)
VirtualNetwork
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
).
updateTunnelCpeDeviceConfig
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateVcnResponse updateVcn(UpdateVcnRequest request)
VirtualNetwork
Updates the specified VCN.
updateVcn
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateVirtualCircuitResponse updateVirtualCircuit(UpdateVirtualCircuitRequest request)
VirtualNetwork
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 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 bulkAddVirtualCircuitPublicPrefixes
and 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.
updateVirtualCircuit
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateVlanResponse updateVlan(UpdateVlanRequest request)
VirtualNetwork
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.
updateVlan
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateVnicResponse updateVnic(UpdateVnicRequest request)
VirtualNetwork
Updates the specified VNIC.
updateVnic
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpdateVtapResponse updateVtap(UpdateVtapRequest request)
VirtualNetwork
Updates the specified VTAP’s display name or tags.
updateVtap
in interface VirtualNetwork
request
- The request object containing the details to sendpublic UpgradeDrgResponse upgradeDrg(UpgradeDrgRequest request)
VirtualNetwork
Upgrades the DRG. After upgrade, you can control routing inside your DRG via DRG attachments, route distributions, and DRG route tables.
upgradeDrg
in interface VirtualNetwork
request
- The request object containing the details to sendpublic ValidateByoipRangeResponse validateByoipRange(ValidateByoipRangeRequest request)
VirtualNetwork
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.
validateByoipRange
in interface VirtualNetwork
request
- The request object containing the details to sendpublic WithdrawByoipRangeResponse withdrawByoipRange(WithdrawByoipRangeRequest request)
VirtualNetwork
Withdraws BGP route advertisement for the BYOIP CIDR block.
withdrawByoipRange
in interface VirtualNetwork
request
- The request object containing the details to sendpublic VirtualNetworkWaiters getWaiters()
VirtualNetwork
Gets the pre-configured waiters available for resources for this service.
getWaiters
in interface VirtualNetwork
public VirtualNetworkWaiters newWaiters(WorkRequest workRequestClient)
VirtualNetwork
Creates a new VirtualNetworkWaiters
for resources for this service.
newWaiters
in interface VirtualNetwork
workRequestClient
- The work request service client used to query for work request
statuspublic VirtualNetworkPaginators getPaginators()
VirtualNetwork
Gets the pre-configured paginators available for list operations in this service which may
return multiple pages of data. These paginators provide an Iterable
interface so that service responses, or resources/records, can be iterated through without
having to manually deal with pagination and page tokens.
getPaginators
in interface VirtualNetwork
protected ClientConfigurator getDefaultConfigurator()
public void useRealmSpecificEndpointTemplate(boolean useOfRealmSpecificEndpointTemplateEnabled)
useOfRealmSpecificEndpointTemplateEnabled
- This flag can be set to true or false to
enable or disable the use of realm-specific endpoint template respectivelypublic final void populateServiceParametersInEndpoint(String endpoint, Map<String,Object> requiredParametersMap)
endpoint
- The endpoint template in userequiredParametersMap
- Map of parameter name as key and value set in request path or
query parameter as valuepublic final void updateBaseEndpoint(String endpoint)
endpoint
- The updated endpoint to usepublic final void setEndpoint(String endpoint)
public final String getEndpoint()
public final void refreshClient()
HttpClient
. This will call ClientConfigurator
s again, and
can be used to e.g. refresh the SSL certificate.public final void close()
close
in interface AutoCloseable
public String getClientCommonLibraryVersion()
Copyright © 2016–2024. All rights reserved.