Try SpotterPerform actions on a Vcn resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Perform actions on a Vcn resource in Oracle Cloud Infrastructure
For I(action=add_ipv6_vcn_cidr), 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.
For I(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 I(action=change_compartment), moves a VCN into a different compartment within the same tenancy. For information about moving resources between compartments, see L(Moving Resources to a Different Compartment,https://docs.cloud.oracle.com/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).
For I(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 I(action=remove_ipv6_vcn_cidr), removing an existing IPv6 prefix from a VCN.
For I(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.
- 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
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
action:
choices:
- add_ipv6_vcn_cidr
- add_vcn_cidr
- change_compartment
- modify_vcn_cidr
- remove_ipv6_vcn_cidr
- remove_vcn_cidr
description:
- The action to perform on the Vcn.
required: true
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
vcn_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the VCN.
required: true
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
cidr_block:
description:
- The CIDR block to add.
- Required for I(action=add_vcn_cidr), I(action=remove_vcn_cidr).
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
wait_timeout:
description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most
of the services but some services might have a longer wait timeout.
type: int
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment to move the VCN to.
- Required for I(action=change_compartment).
type: str
new_cidr_block:
description:
- The new CIDR IP address.
- Required for I(action=modify_vcn_cidr).
type: str
ipv6_cidr_block:
description:
- 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 I(action=remove_ipv6_vcn_cidr).
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
byoipv6_cidr_detail:
description:
- ''
- Applicable only for I(action=add_ipv6_vcn_cidr).
suboptions:
byoipv6_range_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the `ByoipRange` resource to which the CIDR block belongs.
required: true
type: str
ipv6_cidr_block:
description:
- 'An IPv6 prefix required to create a VCN with a BYOIP prefix. It could be the
whole prefix identified in `byoipv6RangeId`, or a subrange. Example: `2001:0db8:0123::/48`'
required: true
type: str
type: dict
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
original_cidr_block:
description:
- The CIDR IP address to update.
- Required for I(action=modify_vcn_cidr).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
ipv6_private_cidr_block:
description:
- 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 I(action=add_ipv6_vcn_cidr).
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
is_oracle_gua_allocation_enabled:
description:
- 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 I(action=add_ipv6_vcn_cidr).
type: bool
realm_specific_endpoint_template_enabled:
description:
- Enable/Disable realm specific endpoint template for service client. By Default,
realm specific endpoint template is disabled. If not set, then the value of the
OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
type: bool
vcn:
contains:
byoipv6_cidr_blocks:
description:
- The list of BYOIPv6 prefixes required to create a VCN that uses BYOIPv6 ranges.
returned: on success
sample: []
type: list
cidr_block:
description:
- Deprecated. The first CIDR IP address from cidrBlocks.
- 'Example: `172.16.0.0/16`'
returned: on success
sample: cidr_block_example
type: str
cidr_blocks:
description:
- The list of IPv4 CIDR blocks the VCN will use.
returned: on success
sample: []
type: list
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the VCN.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
default_dhcp_options_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the VCN's default set of DHCP options.
returned: on success
sample: ocid1.defaultdhcpoptions.oc1..xxxxxxEXAMPLExxxxxx
type: str
default_route_table_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the VCN's default route table.
returned: on success
sample: ocid1.defaultroutetable.oc1..xxxxxxEXAMPLExxxxxx
type: str
default_security_list_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
for the VCN's default security list.
returned: on success
sample: ocid1.defaultsecuritylist.oc1..xxxxxxEXAMPLExxxxxx
type: str
defined_tags:
description:
- Defined tags for this resource. Each key is predefined and scoped to a namespace.
For more information, see L(Resource Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
display_name:
description:
- A user-friendly name. Does not have to be unique, and it's changeable. Avoid
entering confidential information.
returned: on success
sample: display_name_example
type: str
dns_label:
description:
- 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, `bminstance1.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 L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- 'Example: `vcn1`'
returned: on success
sample: dns_label_example
type: str
freeform_tags:
description:
- 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 L(Resource
Tags,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm).
- 'Example: `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The VCN's Oracle ID (L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)).
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
ipv6_cidr_blocks:
description:
- For an IPv6-enabled VCN, this is the list of IPv6 prefixes for the VCN's IP
address space. The prefixes are provided by Oracle and the sizes are always
/56.
returned: on success
sample: []
type: list
ipv6_private_cidr_blocks:
description:
- For an IPv6-enabled VCN, this is the list of Private IPv6 prefixes for the
VCN's IP address space.
returned: on success
sample: []
type: list
lifecycle_state:
description:
- The VCN's current state.
returned: on success
sample: PROVISIONING
type: str
time_created:
description:
- The date and time the VCN was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339).
- 'Example: `2016-08-25T21:10:29.600Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
vcn_domain_name:
description:
- The VCN's domain name, which consists of the VCN's DNS label, and the `oraclevcn.com`
domain.
- For more information, see L(DNS in Your Virtual Cloud Network,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/dns.htm).
- 'Example: `vcn1.oraclevcn.com`'
returned: on success
sample: vcn_domain_name_example
type: str
description:
- Details of the Vcn resource acted upon by the current operation
returned: on success
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
type: complex