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

You might already have this collection installed if you are using the ansible package. 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

any

Certificate path

data

dictionary / required

Defines the FHRP group configuration

auth_key

string

Authentication key (max length 255)

auth_type

string

Authentication type

Choices:

  • "plaintext"

  • "md5"

custom_fields

dictionary

Must exist in NetBox

description

string

Description (max length 200)

group_id

integer / required

Group ID (0 .. 32767)

protocol

string

Protocol

Choices:

  • "vrrp2"

  • "vrrp3"

  • "carp"

  • "clusterxl"

  • "hsrp"

  • "glbp"

  • "other"

tags

list / elements=any

Any tags that the FHRP group may need to be associated with

netbox_token

string / required

The NetBox API token.

netbox_url

string / required

The URL of the NetBox instance.

Must be accessible by the Ansible control host.

query_params

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.

state

string

The state of the object.

Choices:

  • "present" ← (default)

  • "absent"

validate_certs

any

If no, SSL certificates will not be validated.

This should only be used on personally controlled sites using a self-signed certificates.

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

- 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

dictionary

Serialized object as created or already existent within NetBox

Returned: success (when state=present)

msg

string

Message indicating failure or info about what has been achieved

Returned: always

Authors

  • Andrii Konts (@andrii-konts)