community.network.pn_connection_stats_settings module – CLI command to modify connection-stats-settings

Note

This module is part of the community.network collection (version 3.3.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_connection_stats_settings.

Synopsis

  • This module can be used to modify the settings for collecting statistical data about connections.

Parameters

Parameter

Comments

pn_client_server_stats_log_disk_space

string

disk-space allocated for statistics (including rotated log files).

pn_client_server_stats_log_enable

boolean

Enable or disable statistics.

Choices:

  • no

  • yes

pn_client_server_stats_log_interval

string

interval to collect statistics.

pn_client_server_stats_max_memory

string

maximum memory for client server statistics.

pn_cliswitch

string

Target switch to run the CLI on.

pn_connection_backup_enable

boolean

Enable backup for connection statistics collection.

Choices:

  • no

  • yes

pn_connection_backup_interval

string

backup interval for connection statistics collection.

pn_connection_max_memory

string

maximum memory allowed for connection statistics.

pn_connection_stats_log_disk_space

string

disk-space allocated for statistics (including rotated log files).

pn_connection_stats_log_enable

boolean

enable or disable statistics.

Choices:

  • no

  • yes

pn_connection_stats_log_interval

string

interval to collect statistics.

pn_connection_stats_max_memory

string

maximum memory allowed for connection statistics.

pn_enable

boolean

Enable or disable collecting connections statistics.

Choices:

  • no

  • yes

pn_fabric_connection_backup_enable

boolean

enable backup for fabric connection statistics collection.

Choices:

  • no

  • yes

pn_fabric_connection_backup_interval

string

backup interval for fabric connection statistics collection.

pn_fabric_connection_max_memory

string

maximum memory allowed for fabric connection statistics.

pn_service_stat_max_memory

string

maximum memory allowed for service statistics.

state

string / required

State the action to perform. Use update to modify the connection-stats-settings.

Choices:

  • update

Examples

- name: "Modify connection stats settings"
  community.network.pn_connection_stats_settings:
    pn_cliswitch: "sw01"
    state: "update"
    pn_enable: False
    pn_fabric_connection_max_memory: "1000"

- name: "Modify connection stats settings"
  community.network.pn_connection_stats_settings:
    pn_cliswitch: "sw01"
    state: "update"
    pn_enable: True

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

indicates whether the CLI caused changes on the target.

Returned: always

command

string

the CLI command run on the target node.

Returned: always

stderr

list / elements=string

set of error responses from the connection-stats-settings command.

Returned: on error

stdout

list / elements=string

set of responses from the connection-stats-settings command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)