f4f7884306fc89a2a51a07413523e5bd184b745d
[osm/devops.git] / charms / layers / netutils / actions.yaml
1 nmap:
2   description: "nmap a thing!"
3   params:
4     destination:
5       description: "destination to scan"
6       type: string
7   required:
8     - destination
9 ping:
10   description: 'ping a thing!'
11   params:
12     count:
13       description: "Stop after sending count ECHO_REQUEST packets"
14       type: integer
15       default: 30
16     destination:
17       description: "destination of ping request"
18       type: string
19   required:
20     - destination
21 traceroute:
22   description: 'trace a thing!'
23   params:
24     hops:
25       description: "Stop tracing after count hops"
26       type: integer
27       default: 30
28     destination:
29       description: "destination of traceroute request"
30       type: string
31   required:
32     - destination
33 dig:
34   description: "DNS lookup"
35   params:
36     nsserver:
37       description: "The nameserver to lookup against."
38       type: string
39     host:
40       description: "The host to lookup"
41       type: string
42     type:
43       description: "The DNS record type to lookup"
44       type: string
45   required:
46     - host
47 iperf:
48     description: ""
49     params:
50       host:
51         description: ""
52         type: string
53       port:
54         description: ""
55         type: integer
56         default: 5201
57       format:
58         description: ""
59         type: string
60       interval:
61         description: ""
62         type: string
63       affinity:
64         description: ""
65         type: string
66       udp:
67         description: "Use UDP rather than TCP"
68         type: boolean
69         default: False
70       bandwidth:
71         description: "Set the target bandwidth to n bits/sec (default 1Mbit/sec for UDP, unlimited for TCP)"
72         type: integer
73         default: 1
74       time:
75         description: "Time, in seconds, to transmit for."
76         type: integer
77         default: 10
78       blockcount:
79         description: "The number of blocks to transmit"
80         type: integer
81       length:
82         description: "The length of buffer to read or write (default 128KB for TCP, 8KB for UDP)"
83         type: integer
84       parallel:
85         description: "The number of parallel client streams to run"
86         type: integer
87       reverse:
88         description: "Run in reverse mode (server sends, client receives)."
89         type: boolean
90         default: false
91       window:
92         description: "Window size/socket buffer size."
93         type: integer
94       bind:
95         description: "Bind to a specific interface or multicast address"
96         type: string
97       mss:
98         description: "Set the TCP maximum segment size (MTU - 40 bytes)"
99         type: integer
100       no-delay:
101         description: "Set the TCP no delay, disabling Nagle's algorithm."
102         type: boolean
103         default: false
104       ipv4:
105         description: "Only use IPv4"
106         type: boolean
107         default: false
108       ipv6:
109         description: "Only use IPv6"
110         type: boolean
111         default: false
112       tos:
113         description: "Set the IP 'type of service'"
114         type: integer
115       flowlabel:
116         description: "Set the IPv6 flow label (linux-only)"
117         type: string
118       zerocopy:
119         description: "Use a 'zero copy' method of sending data, such as sendfile(s), instead of the usual write(2)."
120         type: boolean
121         default: false
122       omit:
123         description: "Omit the first n seconds of the test, to skip past the TCP slow-start period."
124         type: integer
125       title:
126         description: "Prefix every output line with this string."
127         type: string
128       congestion:
129         description: "Set the linux congestion control algorithm."
130         type: string
131
132     required:
133       - host