netbox_fhrp_group_module.rst

orphan:

netbox.netbox.netbox_fhrp_group module -- Create, update or delete FHRP groups within NetBox

Note

This module is part of the netbox.netbox collection (version 3.13.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

• Synopsis
• Requirements
• Parameters
• Notes
• See Also
• Examples
• Return Values

Synopsis

• Creates, updates or removes FHRP groups from NetBox

Requirements

The below requirements are needed on the host that executes this module.

• pynetbox

Parameters

.. rst-class:: ansible-option-table

Parameter	Comments
.. rst-class:: ansible-option-title cert .. rst-class:: ansible-option-type-line any	Certificate path
.. rst-class:: ansible-option-title data .. rst-class:: ansible-option-type-line dictionary / required	Defines the FHRP group configuration
.. rst-class:: ansible-option-title auth_key .. rst-class:: ansible-option-type-line string	Authentication key (max length 255)
.. rst-class:: ansible-option-title auth_type .. rst-class:: ansible-option-type-line string	Authentication type .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"plaintext"` :ansible-option-choices-entry:`"md5"`
.. rst-class:: ansible-option-title custom_fields .. rst-class:: ansible-option-type-line dictionary	Must exist in NetBox
.. rst-class:: ansible-option-title description .. rst-class:: ansible-option-type-line string	Description (max length 200)
.. rst-class:: ansible-option-title group_id .. rst-class:: ansible-option-type-line integer / required	Group ID (0 .. 32767)
.. rst-class:: ansible-option-title protocol .. rst-class:: ansible-option-type-line string	Protocol .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry:`"vrrp2"` :ansible-option-choices-entry:`"vrrp3"` :ansible-option-choices-entry:`"carp"` :ansible-option-choices-entry:`"clusterxl"` :ansible-option-choices-entry:`"hsrp"` :ansible-option-choices-entry:`"glbp"` :ansible-option-choices-entry:`"other"`
.. rst-class:: ansible-option-title tags .. rst-class:: ansible-option-type-line list / elements=any	Any tags that the FHRP group may need to be associated with
.. rst-class:: ansible-option-title netbox_token .. rst-class:: ansible-option-type-line string / required	The NetBox API token.
.. rst-class:: ansible-option-title netbox_url .. rst-class:: ansible-option-type-line string / required	The URL of the NetBox instance. Must be accessible by the Ansible control host.
.. rst-class:: ansible-option-title query_params .. rst-class:: ansible-option-type-line list / elements=string	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.
.. rst-class:: ansible-option-title state .. rst-class:: ansible-option-type-line string	The state of the object. .. rst-class:: ansible-option-line Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"`
.. rst-class:: ansible-option-title validate_certs .. rst-class:: ansible-option-type-line any	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. .. rst-class:: ansible-option-line Default: :ansible-option-default:`true`

Notes

Note

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

See Also

.. seealso::

   `FHRP Group Model reference <https://docs.netbox.dev/en/stable/models/ipam/fhrpgroup/>`_
       NetBox Documentation for FHRP Group Model.

Examples

- 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

Return Values

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
.. rst-class:: ansible-option-title fhrp_group .. rst-class:: ansible-option-type-line dictionary	Serialized object as created or already existent within NetBox .. rst-class:: ansible-option-line Returned: success (when state=present)
.. rst-class:: ansible-option-title msg .. rst-class:: ansible-option-type-line string	Message indicating failure or info about what has been achieved .. rst-class:: ansible-option-line Returned: always

Authors

• Andrii Konts (@andrii-konts)

Collection links

Issue Tracker Repository (Sources)