community.network.pn_vrouter_pim_config – CLI command to modify vrouter-pim-config
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_vrouter_pim_config.
Synopsis
- This module can be used to modify pim parameters.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| pn_cliswitch
string
|
Target switch to run the CLI on.
|
|
| pn_hello_interval
string
|
hello interval in seconds.
|
|
| pn_querier_timeout
string
|
igmp querier timeout in seconds.
|
|
| pn_query_interval
string
|
igmp query interval in seconds.
|
|
| pn_vrouter_name
string
|
name of service config.
|
|
| state
string / required
|
|
State the action to perform. Use update to modify the vrouter-pim-config.
|
Examples
- name: Pim config modify
community.network.pn_vrouter_pim_config:
pn_cliswitch: '192.168.1.1'
pn_query_interval: '10'
pn_querier_timeout: '30'
state: 'update'
pn_vrouter_name: 'ansible-spine1-vrouter'
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 vrouter-pim-config command.
|
| stdout
list / elements=string
|
always |
set of responses from the vrouter-pim-config 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_vrouter_pim_config_module.html