community.network.pn_dhcp_filter – CLI command to create/modify/delete dhcp-filter
Note
This plugin is part of the community.network collection (version 3.0.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 community.network.
To use it in a playbook, specify: community.network.pn_dhcp_filter.
Synopsis
- This module can be used to create, delete and modify a DHCP filter config.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_cliswitch
string
|
Target switch to run the CLI on.
|
|
| pn_name
string
|
name of the DHCP filter.
|
|
| pn_trusted_ports
string
|
trusted ports of dhcp config.
|
|
| state
string / required
|
|
State the action to perform. Use present to create dhcp-filter and absent to delete dhcp-filter update to modify the dhcp-filter.
|
Examples
- name: Dhcp filter create
community.network.pn_dhcp_filter:
pn_cliswitch: "sw01"
pn_name: "foo"
state: "present"
pn_trusted_ports: "1"
- name: Dhcp filter delete
community.network.pn_dhcp_filter:
pn_cliswitch: "sw01"
pn_name: "foo"
state: "absent"
pn_trusted_ports: "1"
- name: Dhcp filter modify
community.network.pn_dhcp_filter:
pn_cliswitch: "sw01"
pn_name: "foo"
state: "update"
pn_trusted_ports: "1,2"
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed
boolean
|
always |
indicates whether the CLI caused changes on the target.
|
| command
string
|
always |
the CLI command run on the target node.
|
| stderr
list / elements=string
|
on error |
set of error responses from the dhcp-filter command.
|
| stdout
list / elements=string
|
always |
set of responses from the dhcp-filter command.
|
Authors
- Pluribus Networks (@rajaspachipulusu17)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/pn_dhcp_filter_module.html