Skip to content

Commit 528a8e7

Browse files
scaleway-botremyleone
scaleway-bot
and
remyleone
authored
docs: add generated documentation for fip and function (#1999)
Co-authored-by: Rémy Léone <[email protected]>
1 parent 220cd90 commit 528a8e7

File tree

2 files changed

+694
-0
lines changed

2 files changed

+694
-0
lines changed

‎docs/commands/fip.md‎

Lines changed: 245 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,245 @@
1+
<!-- DO NOT EDIT: this file is automatically generated using scw-doc-gen -->
2+
# Documentation for `scw fip`
3+
Flexible IP API
4+
5+
- [Flexible IP management commands](#flexible-ip-management-commands)
6+
- [Attach a Flexible IP to a server](#attach-a-flexible-ip-to-a-server)
7+
- [Create a Flexible IP](#create-a-flexible-ip)
8+
- [Delete a Flexible IP](#delete-a-flexible-ip)
9+
- [Detach a Flexible IP from a server](#detach-a-flexible-ip-from-a-server)
10+
- [Get a Flexible IP](#get-a-flexible-ip)
11+
- [List Flexible IPs](#list-flexible-ips)
12+
- [Update a Flexible IP](#update-a-flexible-ip)
13+
- [MAC address management commands](#mac-address-management-commands)
14+
- [Generate a virtual MAC on a given Flexible IP](#generate-a-virtual-mac-on-a-given-flexible-ip)
15+
- [Remove a virtual MAC from a Flexible IP](#remove-a-virtual-mac-from-a-flexible-ip)
16+
- [Duplicate a Virtual MAC](#duplicate-a-virtual-mac)
17+
18+
19+
## Flexible IP management commands
20+
21+
A Flexible IP can be attached to any server in the same zone.
22+
A server can be linked with multiple Flexible IPs attached to it.
23+
24+
25+
26+
### Attach a Flexible IP to a server
27+
28+
Attach a Flexible IP to a server.
29+
30+
**Usage:**
31+
32+
```
33+
scw fip ip attach [arg=value ...]
34+
```
35+
36+
37+
**Args:**
38+
39+
| Name | | Description |
40+
|------|---|-------------|
41+
| fips-ids.{index} | Required | A list of Flexible IP IDs to attach |
42+
| server-id | Required | A server ID on which to attach the Flexible IPs |
43+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
44+
45+
46+
47+
### Create a Flexible IP
48+
49+
Create a Flexible IP.
50+
51+
**Usage:**
52+
53+
```
54+
scw fip ip create [arg=value ...]
55+
```
56+
57+
58+
**Args:**
59+
60+
| Name | | Description |
61+
|------|---|-------------|
62+
| project-id | | Project ID to use. If none is passed the default project ID will be used |
63+
| description | | Description to associate with the Flexible IP, max 255 characters |
64+
| tags.{index} | | Tags to associate to the Flexible IP |
65+
| server-id | | Server ID on which to attach the created Flexible IP |
66+
| reverse | | Reverse DNS value |
67+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
68+
69+
70+
71+
### Delete a Flexible IP
72+
73+
Delete a Flexible IP.
74+
75+
**Usage:**
76+
77+
```
78+
scw fip ip delete <fip-id ...> [arg=value ...]
79+
```
80+
81+
82+
**Args:**
83+
84+
| Name | | Description |
85+
|------|---|-------------|
86+
| fip-id | Required | ID of the Flexible IP to delete |
87+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
88+
89+
90+
91+
### Detach a Flexible IP from a server
92+
93+
Detach a Flexible IP from a server.
94+
95+
**Usage:**
96+
97+
```
98+
scw fip ip detach [arg=value ...]
99+
```
100+
101+
102+
**Args:**
103+
104+
| Name | | Description |
105+
|------|---|-------------|
106+
| fips-ids.{index} | Required | A list of Flexible IP IDs to detach |
107+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
108+
109+
110+
111+
### Get a Flexible IP
112+
113+
Get a Flexible IP.
114+
115+
**Usage:**
116+
117+
```
118+
scw fip ip get <fip-id ...> [arg=value ...]
119+
```
120+
121+
122+
**Args:**
123+
124+
| Name | | Description |
125+
|------|---|-------------|
126+
| fip-id | Required | Flexible IP ID |
127+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
128+
129+
130+
131+
### List Flexible IPs
132+
133+
List Flexible IPs.
134+
135+
**Usage:**
136+
137+
```
138+
scw fip ip list [arg=value ...]
139+
```
140+
141+
142+
**Args:**
143+
144+
| Name | | Description |
145+
|------|---|-------------|
146+
| order-by | One of: `created_at_asc`, `created_at_desc` | The sort order of the returned Flexible IPs |
147+
| tags.{index} | | Filter Flexible IPs with one or more matching tags |
148+
| status.{index} | One of: `unknown`, `ready`, `updating`, `attached`, `error`, `detaching`, `locked` | Filter Flexible IPs by status |
149+
| server-ids.{index} | | Filter Flexible IPs by server IDs |
150+
| project-id | | Filter Flexible IPs by project ID |
151+
| organization-id | | Filter Flexible IPs by organization ID |
152+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
153+
154+
155+
156+
### Update a Flexible IP
157+
158+
Update a Flexible IP.
159+
160+
**Usage:**
161+
162+
```
163+
scw fip ip update <fip-id ...> [arg=value ...]
164+
```
165+
166+
167+
**Args:**
168+
169+
| Name | | Description |
170+
|------|---|-------------|
171+
| fip-id | Required | ID of the Flexible IP to update |
172+
| description | | Description to associate with the Flexible IP, max 255 characters |
173+
| tags.{index} | | Tags to associate with the Flexible IP |
174+
| reverse | | Reverse DNS value |
175+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
176+
177+
178+
179+
## MAC address management commands
180+
181+
MAC address management commands.
182+
183+
184+
### Generate a virtual MAC on a given Flexible IP
185+
186+
Generate a virtual MAC on a given Flexible IP.
187+
188+
**Usage:**
189+
190+
```
191+
scw fip mac create [arg=value ...]
192+
```
193+
194+
195+
**Args:**
196+
197+
| Name | | Description |
198+
|------|---|-------------|
199+
| fip-id | Required | Flexible IP ID on which to generate a Virtual MAC |
200+
| mac-type | Required<br />One of: `unknown_type`, `vmware`, `xen`, `kvm` | TODO |
201+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
202+
203+
204+
205+
### Remove a virtual MAC from a Flexible IP
206+
207+
Remove a virtual MAC from a Flexible IP.
208+
209+
**Usage:**
210+
211+
```
212+
scw fip mac delete [arg=value ...]
213+
```
214+
215+
216+
**Args:**
217+
218+
| Name | | Description |
219+
|------|---|-------------|
220+
| fip-id | Required | Flexible IP ID from which to delete the Virtual MAC |
221+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
222+
223+
224+
225+
### Duplicate a Virtual MAC
226+
227+
Duplicate a Virtual MAC from a given Flexible IP onto another attached on the same server.
228+
229+
**Usage:**
230+
231+
```
232+
scw fip mac duplicate [arg=value ...]
233+
```
234+
235+
236+
**Args:**
237+
238+
| Name | | Description |
239+
|------|---|-------------|
240+
| fip-id | Required | Flexible IP ID on which to duplicate the Virtual MAC |
241+
| duplicate-from-fip-id | Required | Flexible IP ID to duplicate the Virtual MAC from |
242+
| zone | Default: `fr-par-1`<br />One of: `fr-par-2` | Zone to target. If none is passed will use default zone from the config |
243+
244+
245+

0 commit comments

Comments
 (0)