W3cubDocs

/Ansible 2.11

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

Note

This plugin is part of the community.network collection (version 2.0.1).

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 Choices/Defaults Comments
pn_cliswitch
string
Target switch to run the CLI on.
pn_hog_protect
string
    Choices:
  • disable
  • enable
  • enable-and-drop
enable host-based hog protection.
pn_name
string
name for the CPU class.
pn_rate_limit
string
rate-limit for CPU class.
pn_scope
string
    Choices:
  • local
  • fabric
scope for CPU class.
state
string / required
    Choices:
  • present
  • absent
  • update
State the action to perform. Use present to create cpu-class and absent to delete cpu-class update to modify the cpu-class.

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 Returned Description
changed
boolean
always
indicates whether the CLI caused changes on the target.
command
string
always
the CLI command run on the target node.
stderr
list / elements=string
on error
set of error responses from the cpu-class command.
stdout
list / elements=string
always
set of responses from the cpu-class command.


Authors

  • Pluribus Networks (@rajaspachipulusu17)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/pn_cpu_class_module.html