Try SpotterPerform actions on a VirtualCircuit 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 VirtualCircuit resource in Oracle Cloud Infrastructure
For I(action=bulk_add_virtual_circuit_public_prefixes), adds one or more customer public IP prefixes to the specified public virtual circuit. Use this operation (and not L(UpdateVirtualCircuit,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/VirtualCircuit/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.
For I(action=bulk_delete_virtual_circuit_public_prefixes), removes one or more customer public IP prefixes from the specified public virtual circuit. Use this operation (and not L(UpdateVirtualCircuit,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/iaas/latest/VirtualCircuit/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.
For I(action=change_compartment), moves a virtual circuit 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).
- name: Perform action bulk_add_virtual_circuit_public_prefixes on virtual_circuit
oci_network_virtual_circuit_actions:
# required
public_prefixes:
- # required
cidr_block: cidr_block_example
virtual_circuit_id: "ocid1.virtualcircuit.oc1..xxxxxxEXAMPLExxxxxx"
action: bulk_add_virtual_circuit_public_prefixes
- name: Perform action bulk_delete_virtual_circuit_public_prefixes on virtual_circuit
oci_network_virtual_circuit_actions:
# required
public_prefixes:
- # required
cidr_block: cidr_block_example
virtual_circuit_id: "ocid1.virtualcircuit.oc1..xxxxxxEXAMPLExxxxxx"
action: bulk_delete_virtual_circuit_public_prefixes
- name: Perform action change_compartment on virtual_circuit
oci_network_virtual_circuit_actions:
# required
virtual_circuit_id: "ocid1.virtualcircuit.oc1..xxxxxxEXAMPLExxxxxx"
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
action:
choices:
- bulk_add_virtual_circuit_public_prefixes
- bulk_delete_virtual_circuit_public_prefixes
- change_compartment
description:
- The action to perform on the VirtualCircuit.
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
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
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
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment to move the virtual circuit to.
- Required for I(action=change_compartment).
type: str
public_prefixes:
description:
- The public IP prefixes (CIDRs) to add to the public virtual circuit.
- Required for I(action=bulk_add_virtual_circuit_public_prefixes), I(action=bulk_delete_virtual_circuit_public_prefixes).
elements: dict
suboptions:
cidr_block:
description:
- An individual public IP prefix (CIDR) to add to the public virtual circuit.
All prefix sizes are allowed.
required: true
type: str
type: list
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
virtual_circuit_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the virtual circuit.
required: true
type: str
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
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
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
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
virtual_circuit:
contains:
public_prefixes:
contains:
cidr_block:
description:
- An individual public IP prefix (CIDR) to add to the public virtual circuit.
All prefix sizes are allowed.
returned: on success
sample: cidr_block_example
type: str
description:
- The public IP prefixes (CIDRs) to add to the public virtual circuit.
returned: on success
type: complex
description:
- Details of the VirtualCircuit resource acted upon by the current operation
returned: on success
sample:
public_prefixes:
- cidr_block: cidr_block_example
type: complex