community.network.pn_admin_service module – CLI command to modify admin-service
Note
This module is part of the community.network collection (version 5.0.3).
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_admin_service
.
Synopsis
This module is used to modify services on the server-switch.
Aliases: network.netvisor.pn_admin_service
Parameters
Parameter |
Comments |
---|---|
administrative service interface. Choices:
|
|
Target switch to run the CLI on. |
|
Internet Message Control Protocol (ICMP) to enable or disable. Choices:
|
|
Netvisor API to enable or disable APIs. Choices:
|
|
Network File System (NFS) to enable or disable. Choices:
|
|
Simple Network Monitoring Protocol (SNMP) to enable or disable. Choices:
|
|
Secure Shell to enable or disable. Choices:
|
|
Web (HTTP) to enable or disable. Choices:
|
|
Web logging to enable or disable. Choices:
|
|
Web (HTTP) port to enable or disable. |
|
Web SSL (HTTPS) to enable or disable. Choices:
|
|
Web SSL (HTTPS) port to enable or disable. |
|
State the action to perform. Use Choices:
|
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 |
Description |
---|---|
indicates whether the CLI caused changes on the target. Returned: always |
|
the CLI command run on the target node. Returned: always |
|
set of error responses from the admin-service command. Returned: on error |
|
set of responses from the admin-service command. Returned: always |