oracle.oci.oci_network_vcn_actions – Perform actions on a Vcn resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_network_vcn_actions.

New in version 2.9.0: of oracle.oci

Synopsis

  • Perform actions on a Vcn resource in Oracle Cloud Infrastructure

  • For action=add_ipv6_vcn_cidr, add an IPv6 CIDR to a VCN. The VCN size is always /56 and assigned by Oracle. Once added the IPv6 CIDR block cannot be removed or modified.

  • For action=add_vcn_cidr, 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.

  • For action=change_compartment, 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.

  • For action=modify_vcn_cidr, 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.

  • For action=remove_ipv6_vcn_cidr, removing an existing IPv6 CIDR from a VCN.

  • For action=remove_vcn_cidr, 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.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
action
string / required
    Choices:
  • add_ipv6_vcn_cidr
  • add_vcn_cidr
  • change_compartment
  • modify_vcn_cidr
  • remove_ipv6_vcn_cidr
  • remove_vcn_cidr
The action to perform on the Vcn.
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
byoipv6_cidr_detail
dictionary
Applicable only for action=add_ipv6_vcn_cidr.
byoipv6_range_id
string / required
The OCID of the `ByoipRange` resource to which the CIDR block belongs.
ipv6_cidr_block
string / required
An IPv6 CIDR block required to create a VCN with a BYOIP prefix. It could be the whole CIDR block identified in `byoipv6RangeId`, or a subrange. Example: `2001:0db8:0123::/48`
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
cidr_block
string
The CIDR block to add.
Required for action=add_vcn_cidr, action=remove_vcn_cidr.
compartment_id
string
The OCID of the compartment to move the VCN to.
Required for action=change_compartment.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
ipv6_cidr_block
string
This field is not required and should only be specified when removing ULA or private IPv6 prefix or an IPv6 GUA assigned by Oracle or BYOIPv6 prefix from a VCN's IPv6 address space. SeeL(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
Example: `2001:0db8:0123::/56`
Applicable only for action=remove_ipv6_vcn_cidr.
ipv6_private_cidr_block
string
This field is not required and should only be specified if a ULA or private IPv6 prefix is desired for VCN's private IP address space. SeeL(IPv6 Addresses,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/ipv6.htm).
Example: `2001:0db8:0123::/48` or `fd00:1000:0:1::/64`
Applicable only for action=add_ipv6_vcn_cidr.
is_oracle_gua_allocation_enabled
boolean
    Choices:
  • no
  • yes
Indicates whether Oracle will allocate an IPv6 GUA. Only one prefix of /56 size can be allocated by Oracle as a GUA.
Applicable only for action=add_ipv6_vcn_cidr.
new_cidr_block
string
The new CIDR IP address.
Required for action=modify_vcn_cidr.
original_cidr_block
string
The CIDR IP address to update.
Required for action=modify_vcn_cidr.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
vcn_id
string / required
The OCID of the VCN.

aliases: id
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Perform action add_ipv6_vcn_cidr on vcn
  oci_network_vcn_actions:
    # required
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    action: add_ipv6_vcn_cidr

    # optional
    ipv6_private_cidr_block: ipv6_private_cidr_block_example
    is_oracle_gua_allocation_enabled: true
    byoipv6_cidr_detail:
      # required
      byoipv6_range_id: "ocid1.byoipv6range.oc1..xxxxxxEXAMPLExxxxxx"
      ipv6_cidr_block: ipv6_cidr_block_example

- name: Perform action add_vcn_cidr on vcn
  oci_network_vcn_actions:
    # required
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    cidr_block: cidr_block_example
    action: add_vcn_cidr

- name: Perform action change_compartment on vcn
  oci_network_vcn_actions:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    action: change_compartment

- name: Perform action modify_vcn_cidr on vcn
  oci_network_vcn_actions:
    # required
    original_cidr_block: original_cidr_block_example
    new_cidr_block: new_cidr_block_example
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    action: modify_vcn_cidr

- name: Perform action remove_ipv6_vcn_cidr on vcn
  oci_network_vcn_actions:
    # required
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    action: remove_ipv6_vcn_cidr

    # optional
    ipv6_cidr_block: ipv6_cidr_block_example

- name: Perform action remove_vcn_cidr on vcn
  oci_network_vcn_actions:
    # required
    vcn_id: "ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx"
    cidr_block: cidr_block_example
    action: remove_vcn_cidr

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
vcn
complex
on success
Details of the Vcn resource acted upon by the current operation

Sample:
{'byoipv6_cidr_blocks': [], 'cidr_block': 'cidr_block_example', 'cidr_blocks': [], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'default_dhcp_options_id': 'ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx', 'default_route_table_id': 'ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx', 'default_security_list_id': 'ocid1.defaultsecuritylist.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'dns_label': 'dns_label_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'ipv6_cidr_blocks': [], 'ipv6_private_cidr_blocks': [], 'lifecycle_state': 'PROVISIONING', 'time_created': '2013-10-20T19:20:30+01:00', 'vcn_domain_name': 'vcn_domain_name_example'}
 
byoipv6_cidr_blocks
list / elements=string
on success
The list of BYOIPv6 CIDR blocks required to create a VCN that uses BYOIPv6 ranges.

 
cidr_block
string
on success
Deprecated. The first CIDR IP address from cidrBlocks.
Example: `172.16.0.0/16`

Sample:
cidr_block_example
 
cidr_blocks
list / elements=string
on success
The list of IPv4 CIDR blocks the VCN will use.

 
compartment_id
string
on success
The OCID of the compartment containing the VCN.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
default_dhcp_options_id
string
on success
The OCID for the VCN's default set of DHCP options.

Sample:
ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx
 
default_route_table_id
string
on success
The OCID for the VCN's default route table.

Sample:
ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx
 
default_security_list_id
string
on success
The OCID for the VCN's default security list.

Sample:
ocid1.defaultsecuritylist.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
dns_label
string
on success
A DNS label for the VCN, used in conjunction with the VNIC's hostname and subnet's DNS label to form a fully qualified domain name (FQDN) for each VNIC within this subnet (for example, `bminstance-1.subnet123.vcn1.oraclevcn.com`). Must be an alphanumeric string that begins with a letter. The value cannot be changed.
The absence of this parameter means the Internet and VCN Resolver will not work for this VCN.
For more information, see DNS in Your Virtual Cloud Network.
Example: `vcn1`

Sample:
dns_label_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The VCN's Oracle ID (OCID).

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
ipv6_cidr_blocks
list / elements=string
on success
For an IPv6-enabled VCN, this is the list of IPv6 CIDR blocks for the VCN's IP address space. The CIDRs are provided by Oracle and the sizes are always /56.

 
ipv6_private_cidr_blocks
list / elements=string
on success
For an IPv6-enabled VCN, this is the list of Private IPv6 CIDR blocks for the VCN's IP address space.

 
lifecycle_state
string
on success
The VCN's current state.

Sample:
PROVISIONING
 
time_created
string
on success
The date and time the VCN was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00
 
vcn_domain_name
string
on success
The VCN's domain name, which consists of the VCN's DNS label, and the `oraclevcn.com` domain.
For more information, see DNS in Your Virtual Cloud Network.
Example: `vcn1.oraclevcn.com`

Sample:
vcn_domain_name_example


Authors

  • Oracle (@oracle)