You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ce_netstream_aging - Manages timeout mode of NetStream on HUAWEI CloudEngine switches.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Manages timeout mode of NetStream on HUAWEI CloudEngine switches.

Options ¶

parameter	required	default	choices	comments
manual_slot	no			Specifies the slot number of netstream manual timeout.
state	no	present	present absent	Specify desired state of the resource.
timeout_interval	no	30		Netstream timeout interval. If is active type the interval is 1-60. If is inactive ,the interval is 5-600.
timeout_type	no		active inactive tcp-session manual	Netstream timeout type.
type	no		ip vxlan	Specifies the packet type of netstream timeout active interval.

Examples ¶

- name: netstream aging 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 netstream ip timeout active interval , the interval is 40 minutes.
    ce_netstream_aging:
      timeout_interval: 40
      type: ip
      timeout_type: active
      state: present
      provider: "{{ cli }}"

  - name: Configure netstream vxlan timeout active interval , the interval is 40 minutes.
    ce_netstream_aging:
      timeout_interval: 40
      type: vxlan
      timeout_type: active
      active_state: present
      provider: "{{ cli }}"

  - name: Delete netstream ip timeout active interval , set the ip timeout interval to 30 minutes.
    ce_netstream_aging:
      type: ip
      timeout_type: active
      state: absent
      provider: "{{ cli }}"

  - name: Delete netstream vxlan timeout active interval , set the vxlan timeout interval to 30 minutes.
    ce_netstream_aging:
      type: vxlan
      timeout_type: active
      state: absent
      provider: "{{ cli }}"

  - name: Enable netstream ip tcp session timeout.
    ce_netstream_aging:
      type: ip
      timeout_type: tcp-session
      state: present
      provider: "{{ cli }}"

  - name: Enable netstream vxlan tcp session timeout.
    ce_netstream_aging:
      type: vxlan
      timeout_type: tcp-session
      state: present
      provider: "{{ cli }}"

  - name: Disable netstream ip tcp session timeout.
    ce_netstream_aging:
      type: ip
      timeout_type: tcp-session
      state: absent
      provider: "{{ cli }}"

  - name: Disable netstream vxlan tcp session timeout.
    ce_netstream_aging:
      type: vxlan
      timeout_type: tcp-session
      state: absent
      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	{'active_timeout': [{'ip': 30, 'vxlan': 30}], 'tcp_timeout': [{'ip': 'disable', 'vxlan': 'disable'}], 'inactive_timeout': [{'ip': 30, 'vxlan': 30}]}
existing	k/v pairs of existing configuration	verbose mode	dict	{'active_timeout': [{'ip': '40', 'vxlan': 30}], 'tcp_timeout': [{'ip': 'disable', 'vxlan': 'disable'}], 'inactive_timeout': [{'ip': 30, 'vxlan': 30}]}
proposed	k/v pairs of parameters passed into module	verbose mode	dict	{'timeout_type': 'active', 'state': 'absent', 'type': 'ip', 'timeout_interval': '40'}
updates	commands sent to the device	always	list	['undo netstream timeout ip active 40']

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.