community.network.pn_cpu_class module – CLI command to create/modify/delete cpu-class

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_cpu_class.

Synopsis

  • This module can be used to create, modify and delete CPU class information.

Parameters

Parameter

Comments

pn_cliswitch

string

Target switch to run the CLI on.

pn_hog_protect

string

enable host-based hog protection.

Choices:

  • disable

  • enable

  • enable-and-drop

pn_name

string

name for the CPU class.

pn_rate_limit

string

rate-limit for CPU class.

pn_scope

string

scope for CPU class.

Choices:

  • local

  • fabric

state

string / required

State the action to perform. Use present to create cpu-class and absent to delete cpu-class update to modify the cpu-class.

Choices:

  • present

  • absent

  • update

Examples

- name: Create cpu class
  community.network.pn_cpu_class:
    pn_cliswitch: 'sw01'
    state: 'present'
    pn_name: 'icmp'
    pn_rate_limit: '1000'
    pn_scope: 'local'

- name: Delete cpu class
  community.network.pn_cpu_class:
    pn_cliswitch: 'sw01'
    state: 'absent'
    pn_name: 'icmp'


- name: Modify cpu class
  community.network.pn_cpu_class:
    pn_cliswitch: 'sw01'
    state: 'update'
    pn_name: 'icmp'
    pn_rate_limit: '2000'

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 cpu-class command.

Returned: on error

stdout

list / elements=string

set of responses from the cpu-class command.

Returned: always

Authors

  • Pluribus Networks (@rajaspachipulusu17)