skydive_capture – Module which manages flow capture on interfaces
New in version 2.8.
Synopsis
- This module manages flow capture on interfaces. The Gremlin expression is continuously evaluated which means that it is possible to define a capture on nodes that do not exist yet.
- It is useful when you want to start a capture on all OpenvSwitch whatever the number of Skydive agents you will start.
- While starting the capture, user can specify the capture name, capture description and capture type optionally.
Requirements
The below requirements are needed on the host that executes this module.
- skydive-client
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
capture_name - | Default: "" | To define flow capture name. | |
description - | Default: "" | Configures a text string to be associated with the instance of this object. | |
extra_tcp_metric boolean |
| To define flow capture ExtraTCPMetric. | |
interface_name - | To define flow capture interface name. | ||
ip_defrag boolean |
| To define flow capture IPDefrag. | |
layer_key_mode string | Default: "L2" | To define flow capture Layer KeyMode. | |
provider - | A dict object containing connection details. | ||
endpoint - / required | Specifies the hostname/address along with the port as localhost:8082 for connecting to the remote instance of SKYDIVE client over the REST API. | ||
insecure boolean |
| Ignore SSL certification verification. | |
password - | Specifies the password to use to authenticate the connection to the remote instance of SKYDIVE client. | ||
ssl boolean |
| Specifies the ssl parameter that decides if the connection type shall be http or https. | |
user - | Configures the username to use to authenticate the connection to the remote instance of SKYDIVE client. | ||
query - | It's the complete gremlin query which the users can input, G.V(.Has('Name', 'eth0', 'Type', 'device')), to create the capture. And, if the user directly inputs the gremlin query then user is not required to input any other module parameter as gremlin query takes care of creating the flow capture. | ||
reassemble_tcp boolean |
| To define flow capture ReassembleTCP. | |
state - |
| State of the flow capture. If value is present flow capture will be created else if it is absent it will be deleted. | |
type - | To define flow capture interface type. |
Notes
Note
- This module must be run locally, which can be achieved by specifying
connection: local
.
Examples
- name: start a new flow capture directly from gremlin query skydive_capture: query: G.V().Has('Name', 'eth0', 'Type', 'device') state: present provider: endpoint: localhost:8082 username: admin password: admin - name: stop the flow capture directly from gremlin query skydive_capture: query: G.V().Has('Name', 'eth0', 'Type', 'device') state: absent provider: endpoint: localhost:8082 username: admin password: admin - name: start a new flow capture from user's input skydive_capture: interface_name: Node1 type: myhost capture_name: test_capture description: test description extra_tcp_metric: true ip_defrag: true reassemble_tcp: true state: present provider: endpoint: localhost:8082 username: admin password: admin - name: stop the flow capture skydive_capture: interface_name: Node1 type: myhost capture_name: test_capture description: test description extra_tcp_metric: true ip_defrag: true reassemble_tcp: true state: absent provider: endpoint: localhost:8082 username: admin password: admin
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Sumit Jaiswal (@sjaiswal)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/skydive_capture_module.html