secrets_groups_association¶

Collection Note

This module is part of the networktocode.nautobot collection. To install the collection, use:

ansible-galaxy collection install networktocode.nautobot

Added in version 5.11.0.

You need further requirements to be able to use this module, see the Requirements section for details.

Synopsis¶

Associates secrets to secrets groups

Requirements¶

The following Python packages are needed on the host that executes this module:

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
access_type str	Choices: Generic, Console, gNMI, HTTP(S), NETCONF, REST, RESTCONF, SNMP, SSH	The access type of the secret Required if I(state=present) and the secrets groups association does not exist yet
api_version str		API Version Nautobot REST API Version Added: 4.1.0
id str		The UUID of the object to operate on Version Added: 5.13.0
query_params list / elements=str		This can be used to override the specified values in ALLOWED_QUERY_PARAMS that is defined in plugins/module_utils/utils.py and provides control to users on what may make an object unique in their environment. Version Added: 3.0.0
secret str		The name of the secret to associate to the secrets group Required if I(state=present) and the secrets groups association does not exist yet
secret_type str	Choices: key, password, secret, token, username	The type of the secret Required if I(state=present) and the secrets groups association does not exist yet
secrets_group str		The name of the secrets group to associate the secret to Required if I(state=present) and the secrets groups association does not exist yet
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
token str required		The token created within Nautobot to authorize API access Can be omitted if the E(NAUTOBOT_TOKEN) environment variable is configured.
url str required		The URL of the Nautobot instance resolvable by the Ansible host (for example: http://nautobot.example.com:8000) Can be omitted if the E(NAUTOBOT_URL) environment variable is configured.
validate_certs raw	Default: True	If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. Can be omitted if the E(NAUTOBOT_VALIDATE_CERTS) environment variable is configured.

Notes¶

Note

Tags should be defined as a YAML list
This should be ran with connection C(local) and hosts C(localhost)

Examples¶

---
- name: Associate a secret to a secrets group
  networktocode.nautobot.secrets_groups_association:
    url: http://nautobot.local
    token: thisIsMyToken
    access_type: Generic
    secret_type: key
    secrets_group: My Secrets Group
    secret: My Secret

- name: Remove a secret from a secrets group
  networktocode.nautobot.secrets_groups_association:
    url: http://nautobot.local
    token: thisIsMyToken
    access_type: Generic
    secret_type: key
    secrets_group: My Secrets Group
    secret: My Secret
    state: absent

- name: Delete a secrets groups association by id
  networktocode.nautobot.secrets_groups_association:
    url: http://nautobot.local
    token: thisIsMyToken
    id: 00000000-0000-0000-0000-000000000000
    state: absent

Return Values¶

Key	Data Type	Description	Returned
msg	str	Message indicating failure or info about what has been achieved	always
secrets_groups_association	dict	The secrets groups association	always

Authors¶

Joe Wesch (@joewesch)