Try SpotterManage a TsigKey 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.0This module allows the user to create, update and delete a TsigKey resource in Oracle Cloud Infrastructure
For I(state=present), creates a new TSIG key in the specified compartment. There is no `opc-retry-token` header since TSIG key names must be globally unique.
This resource has the following action operations in the M(oracle.oci.oci_dns_tsig_key_actions) module: change_compartment.
- name: Create tsig_key
oci_dns_tsig_key:
# required
algorithm: algorithm_example
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
secret: secret_example
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
scope: GLOBAL
- name: Update tsig_key
oci_dns_tsig_key:
# required
tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
if_unmodified_since: if_unmodified_since_example
scope: GLOBAL
- name: Update tsig_key using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_dns_tsig_key:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
freeform_tags: {'Department': 'Finance'}
defined_tags: {'Operations': {'CostCenter': 'US'}}
if_unmodified_since: if_unmodified_since_example
scope: GLOBAL
- name: Delete tsig_key
oci_dns_tsig_key:
# required
tsig_key_id: "ocid1.tsigkey.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
# optional
if_unmodified_since: if_unmodified_since_example
scope: GLOBAL
- name: Delete tsig_key using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_dns_tsig_key:
# required
name: name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
name:
description:
- A globally unique domain name identifying the key for a given pair of hosts.
- Required for create using I(state=present).
- Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is set.
type: str
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
scope:
choices:
- GLOBAL
- PRIVATE
description:
- Specifies to operate only on resources that have a matching DNS scope.
- This parameter is updatable.
type: str
state:
choices:
- present
- absent
default: present
description:
- The state of the TsigKey.
- Use I(state=present) to create or update a TsigKey.
- Use I(state=absent) to delete a TsigKey.
required: false
type: str
key_by:
description: The list of attributes of this resource which should be used to uniquely
identify an instance of the resource. By default, all the attributes of a resource
are used to uniquely identify a resource.
elements: str
type: list
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
secret:
description:
- A base64 string encoding the binary shared secret.
- Required for create using I(state=present).
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
algorithm:
description:
- 'TSIG key algorithms are encoded as domain names, but most consist of only one non-empty
label, which is not required to be explicitly absolute. Applicable algorithms include:
hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For more information on these
algorithms, see L(RFC 4635,https://tools.ietf.org/html/rfc4635#section-2).'
- Required for create using I(state=present).
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
tsig_key_id:
aliases:
- id
description:
- The OCID of the target TSIG key.
- Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
- Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER)
is not set.
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
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/Content/General/Concepts/resourcetags.htm).
- '**Example:** `{"Operations": {"CostCenter": "42"}}`'
- This parameter is updatable.
type: dict
force_create:
default: false
description: Whether to attempt non-idempotent creation of a resource. By default,
create resource is an idempotent operation, and doesn't create the resource if it
already exists. Setting this option to true, forcefully creates a copy of the resource,
even if it already exists.This option is mutually exclusive with I(key_by).
type: bool
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
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/Content/General/Concepts/resourcetags.htm).
- '**Example:** `{"Department": "Finance"}`'
- This parameter is updatable.
type: dict
compartment_id:
description:
- The OCID of the compartment containing the TSIG key.
- Required for create using I(state=present).
- Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
- Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set.
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
if_unmodified_since:
description:
- The `If-Unmodified-Since` header field makes the request method conditional on the
selected representation's last modification date being earlier than or equal to
the date provided in the field-value. This field accomplishes the same purpose
as If-Match for cases where the user agent does not have an entity-tag for the representation.
- This parameter is updatable.
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
tsig_key:
contains:
_self:
description:
- The canonical absolute URL of the resource.
returned: on success
sample: _self_example
type: str
algorithm:
description:
- 'TSIG key algorithms are encoded as domain names, but most consist of only
one non-empty label, which is not required to be explicitly absolute. Applicable
algorithms include: hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha512. For
more information on these algorithms, see L(RFC 4635,https://tools.ietf.org/html/rfc4635#section-2).'
returned: on success
sample: algorithm_example
type: str
compartment_id:
description:
- The OCID of the compartment containing the TSIG key.
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/Content/General/Concepts/resourcetags.htm).
- '**Example:** `{"Operations": {"CostCenter": "42"}}`'
returned: on success
sample:
Operations:
CostCenter: US
type: dict
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/Content/General/Concepts/resourcetags.htm).
- '**Example:** `{"Department": "Finance"}`'
returned: on success
sample:
Department: Finance
type: dict
id:
description:
- The OCID of the resource.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
lifecycle_state:
description:
- The current state of the resource.
returned: on success
sample: ACTIVE
type: str
name:
description:
- A globally unique domain name identifying the key for a given pair of hosts.
returned: on success
sample: name_example
type: str
secret:
description:
- A base64 string encoding the binary shared secret.
returned: on success
sample: secret_example
type: str
time_created:
description:
- The date and time the resource was created, expressed in RFC 3339 timestamp
format.
- '**Example:** `2016-07-22T17:23:59:60Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_updated:
description:
- The date and time the resource was last updated, expressed in RFC 3339 timestamp
format.
- '**Example:** `2016-07-22T17:23:59:60Z`'
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- Details of the TsigKey resource acted upon by the current operation
returned: on success
sample:
_self: _self_example
algorithm: algorithm_example
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
defined_tags:
Operations:
CostCenter: US
freeform_tags:
Department: Finance
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
lifecycle_state: ACTIVE
name: name_example
secret: secret_example
time_created: '2013-10-20T19:20:30+01:00'
time_updated: '2013-10-20T19:20:30+01:00'
type: complex