On this page
ce_netstream_global - Manages global parameters of NetStream on HUAWEI CloudEngine switches.
New in version 2.4.
Synopsis
- Manages global parameters of NetStream on HUAWEI CloudEngine switches.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
index_switch |
no | 16 |
|
Specifies the netstream index-switch.
|
interface |
yes |
Netstream global interface.
|
||
sampler_direction |
no |
|
Specifies the netstream sampler direction.
|
|
sampler_interval |
no |
Specifies the netstream sampler interval, length is 1 - 65535.
|
||
state |
no | present |
|
Specify desired state of the resource.
|
statistics_direction |
no |
|
Specifies the netstream statistic direction.
|
|
statistics_record |
no |
Specifies the flexible netstream statistic record, length is 1 - 32.
|
||
type |
no | ip |
|
Specifies the type of netstream global.
|
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.
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.
ce_netstream_global:
type: ip
interface: 10ge1/0/2
statistics_record: test1
provider: "{{ cli }}"
- name: Set the vxlan index-switch to 32.
ce_netstream_global:
type: vxlan
interface: all
index_switch: 32
provider: "{{ cli }}"
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
changed |
check to see if a change was made on the device
|
always | boolean | True |
end_state |
k/v pairs of configuration after module execution
|
verbose mode | dict | {'flexible_statistic': [{'interface': '10ge1/0/2', 'statistics_record': [], 'type': 'ip'}, {'interface': '10ge1/0/2', 'statistics_record': ['test'], 'type': 'vxlan'}], 'sampler': [{'interface': 'all', 'sampler_interval': 'null', 'sampler_direction': 'null'}], 'index-switch': [{'type': 'ip', 'index-switch': '16'}, {'type': 'vxlan', 'index-switch': '16'}], 'statistic': [{'interface': '10ge1/0/2', 'statistics_direction': [], 'type': 'null'}]} |
existing |
k/v pairs of existing configuration
|
verbose mode | dict | {'sampler': [{'interface': 'all', 'sampler_interval': 'null', 'sampler_direction': 'null'}], 'flexible_statistic': [{'interface': '10ge1/0/2', 'statistics_record': [], 'type': 'ip'}, {'interface': '10ge1/0/2', 'statistics_record': [], 'type': 'vxlan'}], 'vxlan_record': ['test'], 'statistic': [{'interface': '10ge1/0/2', 'statistics_direction': [], 'type': 'null'}], 'ip_record': ['test', 'test1'], 'index-switch': [{'type': 'ip', 'index-switch': '16'}, {'type': 'vxlan', 'index-switch': '16'}]} |
proposed |
k/v pairs of parameters passed into module
|
verbose mode | dict | {'interface': '10ge1/0/2', 'state': 'present', 'index_switch': '16', 'type': 'vxlan', 'statistics_record': 'test'} |
updates |
commands sent to the device
|
always | list | ['interface 10ge1/0/2', 'netstream record test vxlan inner-ip'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ce_netstream_global_module.html