/ home / community / community.general / 0.1.1 / module / pn_admin_service

community.general.pn_admin_service (0.1.1) — module

CLI command to modify admin-service

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 is used to modify services on the server-switch.

Usage examples

Scanned by Steampunk Spotter

- name: admin service functionality
  pn_admin_service:
    pn_cliswitch: "sw01"
    state: "update"
    pn__if: "mgmt"
    pn_web: False
    pn_icmp: True

Scanned by Steampunk Spotter

- name: admin service functionality
  pn_admin_service:
    pn_cliswitch: "sw01"
    state: "update"
    pn_web: False
    pn__if: "mgmt"
    pn_snmp: True
    pn_net_api: True
    pn_ssh: True

Inputs

    
state:
    choices:
    - update
    description:
    - State the action to perform. Use C(update) to modify the admin-service.
    required: true
    type: str

pn__if:
    choices:
    - mgmt
    - data
    description:
    - administrative service interface.
    required: false
    type: str

pn_nfs:
    description:
    - Network File System (NFS) to enable or disable.
    required: false
    type: bool

pn_ssh:
    description:
    - Secure Shell to enable or disable.
    required: false
    type: bool

pn_web:
    description:
    - Web (HTTP) to enable or disable.
    required: false
    type: bool

pn_icmp:
    description:
    - Internet Message Control Protocol (ICMP) to enable or disable.
    required: false
    type: bool

pn_snmp:
    description:
    - Simple Network Monitoring Protocol (SNMP) to enable or disable.
    required: false
    type: bool

pn_net_api:
    description:
    - Netvisor API to enable or disable APIs.
    required: false
    type: bool

pn_web_log:
    description:
    - Web logging to enable or disable.
    required: false
    type: bool

pn_web_ssl:
    description:
    - Web SSL (HTTPS) to enable or disable.
    required: false
    type: bool

pn_web_port:
    description:
    - Web (HTTP) port to enable or disable.
    required: false
    type: str

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

pn_web_ssl_port:
    description:
    - Web SSL (HTTPS) port to enable or disable.
    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 admin-service command.
  returned: on error
  type: list
stdout:
  description: set of responses from the admin-service command.
  returned: always
  type: list