netapp.storagegrid.na_sg_grid_traffic_classes module – Manage Traffic Classification Policy configuration on StorageGRID.
Note
This module is part of the netapp.storagegrid collection (version 21.13.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 netapp.storagegrid
.
To use it in a playbook, specify: netapp.storagegrid.na_sg_grid_traffic_classes
.
Note
The netapp.storagegrid collection is considered unmaintained and will be removed from Ansible 11. See the discussion thread for more information.
New in netapp.storagegrid 21.10.0
Synopsis
Create, Update, Delete Traffic Classification Policies on NetApp StorageGRID.
Parameters
Parameter |
Comments |
---|---|
The url to the StorageGRID Admin Node REST API. |
|
The authorization token for the API request |
|
Description of the Traffic Classification Policy. |
|
Optional limits to impose on client requests matched by this traffic class. Only one of each limit type can be specified. |
|
The type of limit to apply.
Choices:
|
|
The limit to apply. Limit values are type specific. |
|
A set of parameters to match. The traffic class will match requests where any of these matchers match. |
|
If true, entities that match the value are excluded. Choices:
|
|
A list of members to match on. |
|
The attribute of the request to match.
Choices:
|
|
Name of the Traffic Classification Policy. |
|
Traffic Classification Policy ID. May be used for modify or delete operation. |
|
Whether the specified Traffic Classification Policy should exist. Choices:
|
|
Should https certificates be validated? Choices:
|
Notes
Note
The modules prefixed with
na_sg
are built to manage NetApp StorageGRID.
Examples
- name: create Traffic Classification Policy with bandwidth limit on buckets
netapp.storagegrid.na_sg_grid_traffic_classes:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
name: Traffic-Policy1
matchers:
- type: bucket
members: bucket1,anotherbucket
limits:
- type: aggregateBandwidthOut
value: 100000000
- name: create Traffic Classification Policy with bandwidth limits except for specific tenant account
netapp.storagegrid.na_sg_grid_traffic_classes:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
name: Fabricpool-Policy
description: "Limit all to 500MB/s except FabricPool tenant"
matchers:
- type: tenant
inverse: True
members: 12345678901234567890
limits:
- type: aggregateBandwidthIn
value: 50000000
- type: aggregateBandwidthOut
value: 50000000
- name: rename Traffic Classification Policy
netapp.storagegrid.na_sg_grid_traffic_classes:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: present
policy_id: 00000000-0000-0000-0000-000000000000
name: Traffic-Policy1-New-Name
matchers:
- type: bucket
members: bucket1,anotherbucket
limits:
- type: aggregateBandwidthOut
value: 100000000
- name: delete Traffic Classification Policy
netapp.storagegrid.na_sg_grid_traffic_classes:
api_url: "https://<storagegrid-endpoint-url>"
auth_token: "storagegrid-auth-token"
validate_certs: false
state: absent
name: Traffic-Policy1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Returns information about the StorageGRID Traffic Classification Policy. Returned: success Sample: |