community.general.pn_dhcp_filter (0.1.1) — module

CLI command to create/modify/delete dhcp-filter

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, delete and modify a DHCP filter config.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: dhcp filter create
  pn_dhcp_filter:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    state: "present"
    pn_trusted_ports: "1"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: dhcp filter delete
  pn_dhcp_filter:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    state: "absent"
    pn_trusted_ports: "1"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: dhcp filter modify
  pn_dhcp_filter:
    pn_cliswitch: "sw01"
    pn_name: "foo"
    state: "update"
    pn_trusted_ports: "1,2"

Inputs

    
state:
    choices:
    - present
    - absent
    - update
    description:
    - State the action to perform. Use C(present) to create dhcp-filter and C(absent)
      to delete dhcp-filter C(update) to modify the dhcp-filter.
    required: true
    type: str

pn_name:
    description:
    - name of the DHCP filter.
    required: false
    type: str

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

pn_trusted_ports:
    description:
    - trusted ports of dhcp config.
    required: false
    type: str

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 dhcp-filter command.
  returned: on error
  type: list
stdout:
  description: set of responses from the dhcp-filter command.
  returned: always
  type: list