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.22.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netbox.netbox. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: netbox.netbox.netbox_fhrp_group.

New in netbox.netbox 3.12.0

Synopsis

• Creates, updates or removes FHRP groups from NetBox

Requirements

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

• pynetbox

Parameters

Parameter	Comments
cert	Certificate path
data	Defines the FHRP group configuration
auth_key	Authentication key (max length 255)
auth_type	Authentication type :ansible-option-choices:`Choices:` :ansible-option-choices-entry:`"plaintext"` :ansible-option-choices-entry:`"md5"`
custom_fields	Must exist in NetBox
description	Description (max length 200)
group_id	Group ID (0 .. 32767)
name :ansible-option-versionadded:`added in netbox.netbox 3.21.0`	Name of the FHRP group
protocol	Protocol :ansible-option-choices:`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"`
tags	Any tags that the FHRP group may need to be associated with
headers	Dictionary of headers to be passed to the NetBox API.
netbox_token	The NetBox API token.
netbox_url	The URL of the NetBox instance. Must be accessible by the Ansible control host.
query_params	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.
state	The state of the object. :ansible-option-choices:`Choices:` :ansible-option-choices-entry-default:`"present"` :ansible-option-choices-default-mark:`← (default)` :ansible-option-choices-entry:`"absent"`
validate_certs	If no, SSL certificates will not be validated. This should only be used on personally controlled sites using a self-signed certificates. :ansible-option-default-bold:`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

See also

FHRP Group Model reference

NetBox Documentation for FHRP Group Model.

Examples

- name: "Test NetBox modules"
  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 here, the following are the fields unique to this module:

Key	Description
fhrp_group	Serialized object as created or already existent within NetBox :ansible-option-returned-bold:`Returned:` success (when state=present)
msg	Message indicating failure or info about what has been achieved :ansible-option-returned-bold:`Returned:` always

Authors

• Andrii Konts (@andrii-konts)

Collection links