community.network.ce_netstream_global – Manages global parameters of NetStream on HUAWEI CloudEngine switches.
Note
This plugin is part of the community.network collection (version 3.0.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.ce_netstream_global
.
Parameters
Parameter |
Comments |
---|---|
Specifies the netstream index-switch. Choices:
|
|
Netstream global interface. |
|
Specifies the netstream sampler direction. Choices:
|
|
Specifies the netstream sampler interval, length is 1 - 65535. |
|
Specify desired state of the resource. Choices:
|
|
Specifies the netstream statistic direction. Choices:
|
|
Specifies the flexible netstream statistic record, length is 1 - 32. |
|
Specifies the type of netstream global. Choices:
|
Notes
Note
Recommended connection is
network_cli
.This module also works with
local
connections for legacy playbooks.
Examples
- name: Netstream global module test
hosts: cloudengine
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: Configure a netstream sampler at interface 10ge1/0/2, direction is outbound,interval is 30.
community.network.ce_netstream_global:
interface: 10ge1/0/2
type: ip
sampler_interval: 30
sampler_direction: outbound
state: present
provider: "{{ cli }}"
- name: Configure a netstream flexible statistic at interface 10ge1/0/2, record is test1, type is ip.
community.network.ce_netstream_global:
type: ip
interface: 10ge1/0/2
statistics_record: test1
provider: "{{ cli }}"
- name: Set the vxlan index-switch to 32.
community.network.ce_netstream_global:
type: vxlan
interface: all
index_switch: 32
provider: "{{ cli }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: true |
|
k/v pairs of configuration after module execution Returned: verbose mode Sample: {“flexible_statistic”: [{“interface”: “10ge1/0/2”, “statistics_record”: [], “type”: “ip”}, {“interface”: “10ge1/0/2”, “statistics_record”: [“test”], “type”: “vxlan”}], “index-switch”: [{“index-switch”: “16”, “type”: “ip”}, {“index-switch”: “16”, “type”: “vxlan”}], “sampler”: [{“interface”: “all”, “sampler_direction”: “null”, “sampler_interval”: “null”}], “statistic”: [{“interface”: “10ge1/0/2”, “statistics_direction”: [], “type”: “null”}]} |
|
k/v pairs of existing configuration Returned: verbose mode Sample: {“flexible_statistic”: [{“interface”: “10ge1/0/2”, “statistics_record”: [], “type”: “ip”}, {“interface”: “10ge1/0/2”, “statistics_record”: [], “type”: “vxlan”}], “index-switch”: [{“index-switch”: “16”, “type”: “ip”}, {“index-switch”: “16”, “type”: “vxlan”}], “ip_record”: [“test”, “test1”], “sampler”: [{“interface”: “all”, “sampler_direction”: “null”, “sampler_interval”: “null”}], “statistic”: [{“interface”: “10ge1/0/2”, “statistics_direction”: [], “type”: “null”}], “vxlan_record”: [“test”]} |
|
k/v pairs of parameters passed into module Returned: verbose mode Sample: {“index_switch”: “16”, “interface”: “10ge1/0/2”, “state”: “present”, “statistics_record”: “test”, “type”: “vxlan”} |
|
commands sent to the device Returned: always Sample: [“interface 10ge1/0/2”, “netstream record test vxlan inner-ip”] |
Authors
YangYang (@QijunPan)