community.network.pn_admin_service – CLI command to modify admin-service

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.pn_admin_service.

Synopsis
Parameters
Examples
Return Values

Synopsis

This module is used to modify services on the server-switch.

Parameters

Parameter	Choices/Defaults	Comments
pn__if string	mgmt data	administrative service interface.
pn_cliswitch string		Target switch to run the CLI on.
pn_icmp boolean	no yes	Internet Message Control Protocol (ICMP) to enable or disable.
pn_net_api boolean	no yes	Netvisor API to enable or disable APIs.
pn_nfs boolean	no yes	Network File System (NFS) to enable or disable.
pn_snmp boolean	no yes	Simple Network Monitoring Protocol (SNMP) to enable or disable.
pn_ssh boolean	no yes	Secure Shell to enable or disable.
pn_web boolean	no yes	Web (HTTP) to enable or disable.
pn_web_log boolean	no yes	Web logging to enable or disable.
pn_web_port string		Web (HTTP) port to enable or disable.
pn_web_ssl boolean	no yes	Web SSL (HTTPS) to enable or disable.
pn_web_ssl_port string		Web SSL (HTTPS) port to enable or disable.
state string / required	update	State the action to perform. Use `update` to modify the admin-service.

Examples

- name: Admin service functionality
  community.network.pn_admin_service:
    pn_cliswitch: "sw01"
    state: "update"
    pn__if: "mgmt"
    pn_web: False
    pn_icmp: True

- name: Admin service functionality
  community.network.pn_admin_service:
    pn_cliswitch: "sw01"
    state: "update"
    pn_web: False
    pn__if: "mgmt"
    pn_snmp: True
    pn_net_api: True
    pn_ssh: True

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 admin-service command.
stdout list / elements=string	always	set of responses from the admin-service 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/2.11/collections/community/network/pn_admin_service_module.html