Try SpotterPerform actions on a ByoipRange 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 ByoipRange resource in Oracle Cloud Infrastructure
For I(action=advertise), 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.
For I(action=change_compartment), moves a BYOIP CIDR block to a different compartment. 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=validate), 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 L(To import a CIDR block,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr) for details.
For I(action=withdraw), withdraws BGP route advertisement for the BYOIP CIDR block.
- name: Perform action advertise on byoip_range
oci_network_byoip_range_actions:
# required
byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
action: advertise
- name: Perform action change_compartment on byoip_range
oci_network_byoip_range_actions:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
action: change_compartment
- name: Perform action validate on byoip_range
oci_network_byoip_range_actions:
# required
byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
action: validate
- name: Perform action withdraw on byoip_range
oci_network_byoip_range_actions:
# required
byoip_range_id: "ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx"
action: withdraw
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
action:
choices:
- advertise
- change_compartment
- validate
- withdraw
description:
- The action to perform on the ByoipRange.
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
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
byoip_range_id:
aliases:
- id
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the `ByoipRange` resource containing the BYOIP CIDR block.
required: true
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the destination compartment for the BYOIP CIDR block move.
- Required for I(action=change_compartment).
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
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
byoip_range:
contains:
byoip_range_vcn_ipv6_allocations:
contains:
byoip_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.
returned: on success
sample: ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the `ByoipRange`.
returned: on success
sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
type: str
ipv6_cidr_block:
description:
- The BYOIPv6 prefix range or subrange allocated to a VCN. This could be
all or part of a BYOIPv6 prefix. Each VCN allocation must be /64 or larger.
returned: on success
sample: ipv6_cidr_block_example
type: str
vcn_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the `Vcn` resource to which the ByoipRange belongs.
returned: on success
sample: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
type: str
description:
- A list of `ByoipRangeVcnIpv6AllocationSummary` objects.
returned: on success
type: complex
cidr_block:
description:
- The public IPv4 CIDR block being imported from on-premises to the Oracle cloud.
returned: on success
sample: cidr_block_example
type: str
compartment_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the compartment containing the BYOIP CIDR block.
returned: on success
sample: ocid1.compartment.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
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 L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm)
of the `ByoipRange` resource.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
ipv6_cidr_block:
description:
- The IPv6 prefix being imported to the Oracle cloud. This prefix must be /48
or larger, and can be subdivided into sub-ranges used across multiple VCNs.
A BYOIPv6 prefix can be also assigned across multiple VCNs, and each VCN must
be /64 or larger. You may specify a ULA or private IPv6 prefix of /64 or larger
to use in the VCN. IPv6-enabled subnets will remain a fixed /64 in size.
returned: on success
sample: ipv6_cidr_block_example
type: str
lifecycle_details:
description:
- The `ByoipRange` resource's current status.
returned: on success
sample: CREATING
type: str
lifecycle_state:
description:
- The `ByoipRange` resource's current state.
returned: on success
sample: INACTIVE
type: str
time_advertised:
description:
- The date and time the `ByoipRange` resource was advertised to the internet
by BGP, 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
time_created:
description:
- The date and time the `ByoipRange` resource 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
time_validated:
description:
- The date and time the `ByoipRange` resource was validated, 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
time_withdrawn:
description:
- The date and time the `ByoipRange` resource was withdrawn from advertisement
by BGP to the internet, 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
validation_token:
description:
- The validation token is an internally-generated ASCII string used in the validation
process. See L(Importing a CIDR block,https://docs.cloud.oracle.com/iaas/Content/Network/Concepts/BYOIP.htm#import_cidr)
for details.
returned: on success
sample: validation_token_example
type: str
description:
- Details of the ByoipRange resource acted upon by the current operation
returned: on success
sample:
byoip_range_vcn_ipv6_allocations:
- byoip_range_id: ocid1.byoiprange.oc1..xxxxxxEXAMPLExxxxxx
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
ipv6_cidr_block: ipv6_cidr_block_example
vcn_id: ocid1.vcn.oc1..xxxxxxEXAMPLExxxxxx
cidr_block: cidr_block_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
display_name: display_name_example
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
ipv6_cidr_block: ipv6_cidr_block_example
lifecycle_details: CREATING
lifecycle_state: INACTIVE
time_advertised: '2013-10-20T19:20:30+01:00'
time_created: '2013-10-20T19:20:30+01:00'
time_validated: '2013-10-20T19:20:30+01:00'
time_withdrawn: '2013-10-20T19:20:30+01:00'
validation_token: validation_token_example
type: complex