regex_rule¶

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 6.1.0.

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

Synopsis¶

Creates, updates or removes regex rules from Nautobot

Requirements¶

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

pynautobot

Parameters¶

Parameter	Defaults / Choices	Comments
api_version str		API Version Nautobot REST API Version Added: 4.1.0
contacts dict		Associate contacts Version Added: 6.3.0
contacts.objects		List of contacts to associate.
contacts.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
content_type str		The content type of the regex rule (e.g., dcim.device, ipam.prefix, etc.) Required if I(state=present) and the regex rule does not exist yet
context_processing bool		When enabled, the regular expression value is first processed as a Jinja2 template You may reference the context of the data being validated via the variable named C(object).
custom_fields dict		Must exist in Nautobot and in key/value format Version Added: 3.0.0
enabled bool		Whether the regex rule is enabled or disabled
error_message str		The error message to display if the regex rule is violated
field str		The field to apply the regex rule to (e.g., name, description, etc.) Required if I(state=present) and the regex rule does not exist yet
id str		The UUID of the object to operate on Version Added: 5.13.0
name str		The name of the regex rule Required if I(state=present) and the regex rule does not exist yet
notes dict		Manage notes on the object Version Added: 6.3.0
notes.objects		List of notes to manage.
notes.state	Default: merge Choices: merge, replace, delete	C(merge) adds notes without removing existing ones. C(replace) enforces exactly the listed notes, removing any extras. C(delete) removes the listed notes.
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
regular_expression str		The regular expression pattern to apply to the field Required if I(state=present) and the regex rule does not exist yet
state str	Default: present Choices: absent, present	Use C(present) or C(absent) for adding or removing.
tags list / elements=raw		Any tags that this item may need to be associated with Version Added: 3.0.0
teams dict		Associate teams Version Added: 6.3.0
teams.objects		List of teams to associate.
teams.state	Default: merge Choices: merge, replace, delete	C(merge) adds associations without removing existing ones. C(replace) enforces exactly the listed associations, removing any extras. C(delete) removes the listed associations.
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: Create a regex rule
  networktocode.nautobot.regex_rule:
    url: http://nautobot.local
    token: thisIsMyToken
    name: "My Regex Rule"
    content_type: "dcim.device"
    field: "name"
    regular_expression: "[A-Z]{3}-[0-9]+"
    state: present

- name: Create a regex rule with context processing
  networktocode.nautobot.regex_rule:
    url: http://nautobot.local
    token: thisIsMyToken
    name: "My Regex Rule"
    content_type: "dcim.device"
    field: "name"
    regular_expression: "{% raw %}^{{ object.location.name }}-{% endraw %}"
    enabled: true
    error_message: "Name must start with the location name"
    state: present

- name: Delete a regex rule
  networktocode.nautobot.regex_rule:
    url: http://nautobot.local
    token: thisIsMyToken
    name: "My Regex Rule"
    state: absent

- name: Delete a regex rule by id
  networktocode.nautobot.regex_rule:
    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
regex_rule	dict	Serialized object as created or already existent within Nautobot	success (when I(state=present))

Authors¶

Joe Wesch (@joewesch)