community.general.pn_vtep (0.1.1) — module

CLI command to create/delete vtep

Authors: Pluribus Networks (@rajaspachipulusu17)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module can be used to create a vtep and delete a vtep.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create vtep
  pn_vtep:
    pn_cliswitch: 'sw01'
    pn_name: 'foo'
    pn_vrouter_name: 'foo-vrouter'
    pn_ip: '22.22.22.2'
    pn_location: 'sw01'
    pn_virtual_ip: "22.22.22.1"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete vtep
  pn_vtep:
    pn_cliswitch: 'sw01'
    state: 'absent'
    pn_name: 'foo'

Inputs

    
pn_ip:
    description:
    - Primary IP address.
    required: false
    type: str

state:
    choices:
    - present
    - absent
    default: present
    description:
    - vtep configuration command.
    required: false
    type: str

pn_name:
    description:
    - vtep name.
    required: false
    type: str

pn_location:
    description:
    - switch name.
    required: false
    type: str

pn_cliswitch:
    description:
    - Target switch to run the CLI on.
    required: false
    type: str

pn_virtual_ip:
    description:
    - Virtual/Secondary IP address.
    required: false
    type: str

pn_vrouter_name:
    description:
    - name of the vrouter service.
    required: false
    type: str

pn_switch_in_cluster:
    default: true
    description:
    - Tells whether switch in cluster or not.
    required: false
    type: bool

Outputs

changed:
  description: indicates whether the CLI caused changes on the target.
  returned: always
  type: bool
command:
  description: the CLI command run on the target node.
  returned: always
  type: str
stderr:
  description: set of error responses from the vtep command.
  returned: on error
  type: list
stdout:
  description: set of responses from the vtep command.
  returned: always
  type: list