orphan: |
---|
Note
This module is part of the netbox.netbox collection (version 3.14.0).
To install it, use: ansible-galaxy collection install netbox.netbox
.
You need further requirements to be able to use this module,
see :ref:`Requirements <ansible_collections.netbox.netbox.netbox_fhrp_group_module_requirements>` for details.
To use it in a playbook, specify: netbox.netbox.netbox_fhrp_group
.
.. rst-class:: ansible-version-added
New in netbox.netbox 3.12.0
- Creates, updates or removes FHRP groups from NetBox
The below requirements are needed on the host that executes this module.
- pynetbox
.. rst-class:: ansible-option-table
Parameter | Comments |
---|---|
Certificate path |
|
Defines the FHRP group configuration |
|
Authentication key (max length 255) |
|
Authentication type .. rst-class:: ansible-option-line Choices: |
|
Must exist in NetBox |
|
Description (max length 200) |
|
Group ID (0 .. 32767) |
|
Protocol .. rst-class:: ansible-option-line Choices: |
|
Any tags that the FHRP group may need to be associated with |
|
The NetBox API token. |
|
The URL of the NetBox instance. Must be accessible by the Ansible control host. |
|
This can be used to override the specified values in ALLOWED_QUERY_PARAMS that are defined in plugins/module_utils/netbox_utils.py and provides control to users on what may make an object unique in their environment. |
|
The state of the object. .. rst-class:: ansible-option-line Choices: |
|
If This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line Default: :ansible-option-default:`true` |
Note
- Tags should be defined as a YAML list
- This should be ran with connection
local
and hostslocalhost
.. seealso:: `FHRP Group Model reference <https://docs.netbox.dev/en/stable/models/ipam/fhrpgroup/>`_ NetBox Documentation for FHRP Group Model.
- hosts: localhost
connection: local
module_defaults:
group/netbox.netbox.netbox:
netbox_url: "http://netbox.local"
netbox_token: "thisIsMyToken"
tasks:
- name: "Create FHRP group within netbox"
netbox.netbox.netbox_fhrp_group:
data:
protocol: "glbp"
group_id: 111
auth_type: md5
auth_key: 11111
description: test FHRP group
state: present
- name: Delete FHRP group within netbox
netbox.netbox.netbox_fhrp_group:
data:
group_id: 111
state: absent
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:
.. rst-class:: ansible-option-table
Key | Description |
---|---|
Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: success (when state=present) |
|
Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always |
- Andrii Konts (@andrii-konts)