community.general.pn_connection_stats_settings (0.1.1) — module

CLI command to modify connection-stats-settings

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 can be used to modify the settings for collecting statistical data about connections.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Modify connection stats settings"
  pn_connection_stats_settings:
    pn_cliswitch: "sw01"
    state: "update"
    pn_enable: False
    pn_fabric_connection_max_memory: "1000"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: "Modify connection stats settings"
  pn_connection_stats_settings:
    pn_cliswitch: "sw01"
    state: "update"
    pn_enable: True

Inputs

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

pn_enable:
    description:
    - Enable or disable collecting connections statistics.
    required: false
    type: bool

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

pn_connection_max_memory:
    description:
    - maximum memory allowed for connection statistics.
    required: false
    type: str

pn_service_stat_max_memory:
    description:
    - maximum memory allowed for service statistics.
    required: false
    type: str

pn_connection_backup_enable:
    description:
    - Enable backup for connection statistics collection.
    required: false
    type: bool

pn_connection_backup_interval:
    description:
    - backup interval for connection statistics collection.
    required: false
    type: str

pn_connection_stats_log_enable:
    description:
    - enable or disable statistics.
    required: false
    type: bool

pn_connection_stats_max_memory:
    description:
    - maximum memory allowed for connection statistics.
    required: false
    type: str

pn_fabric_connection_max_memory:
    description:
    - maximum memory allowed for fabric connection statistics.
    required: false
    type: str

pn_connection_stats_log_interval:
    description:
    - interval to collect statistics.
    required: false
    type: str

pn_client_server_stats_log_enable:
    description:
    - Enable or disable statistics.
    required: false
    type: bool

pn_client_server_stats_max_memory:
    description:
    - maximum memory for client server statistics.
    required: false
    type: str

pn_connection_stats_log_disk_space:
    description:
    - disk-space allocated for statistics (including rotated log files).
    required: false
    type: str

pn_fabric_connection_backup_enable:
    description:
    - enable backup for fabric connection statistics collection.
    required: false
    type: bool

pn_client_server_stats_log_interval:
    description:
    - interval to collect statistics.
    required: false
    type: str

pn_fabric_connection_backup_interval:
    description:
    - backup interval for fabric connection statistics collection.
    required: false
    type: str

pn_client_server_stats_log_disk_space:
    description:
    - disk-space allocated for statistics (including rotated log files).
    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 connection-stats-settings command.
  returned: on error
  type: list
stdout:
  description: set of responses from the connection-stats-settings command.
  returned: always
  type: list