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