netactuate.compute.bgp (1.1.1) — module

Install collection

Install with ansible-galaxy collection install netactuate.compute:==1.1.1

Add to requirements.yml

  collections:
    - name: netactuate.compute
      version: 1.1.1

Description

Retrieve BGP session information for NetActuate nodes

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Retrieve session configuration
  hosts: all
  remote_user: root
  gather_facts: no
  netactuate.compute.bgp:
    auth_token: "{{ auth_token }}"
    hostname: "{{ inventory_hostname }}"
  delegate_to: localhost
  register: nodebgp

Inputs

    
ipv6:
    default: true
    description:
    - Request IPv6 sessions in addition to IPv4.

build:
    default: false
    description:
    - Request provisioning of sessions to fulfil requirements as defined by parameters.

mbpkgid:
    description:
    - The purchased package ID the node is associated with. Optional if C(hostname) is
      a unique identifier.

group_id:
    description:
    - The unique NetActuate-provided BGP group identifier with which to associate requested
      sessions.

hostname:
    description:
    - Hostname of the node for which to provision sessions and/or retrieve session configuration
      details.

redundant:
    default: false
    description:
    - Request two sessions be provisioned for redundancy.

auth_token:
    description:
    - API Key which should be set in ENV variable HOSTVIRTUAL_API_KEY
    - C(auth_token) is required.

Outputs

bgp_peers:
  description: BGP Sesssions
  returned: success
  sample: '{ "IPv4": [ "192.0.2.1" ], "IPv6": [ "2001:db8::1" ], "group_id": "9999",
    "localasn": 65002, "peerasn": "65001", "localpeerv4": "192.0.2.2", "localpeerv6":
    "2001:db8::2" }'
  type: dict
hostname:
  description: Device FQDN
  returned: success
  sample: a.b.com
  type: string
id:
  description: Device UUID.
  returned: success
  sample: 5551212
  type: string
private_ipv4:
  description: Private IPv4 Address
  returned: success
  sample: 10.100.11.129
  type: string
public_ipv6:
  description: Public IPv6 Address
  returned: success
  sample: ::1
  type: string
state:
  description: Device state
  returned: success
  sample: running
  type: string