Skip to content

Commit

Permalink
chore: remove nat from documentation (#4475)
Browse files Browse the repository at this point in the history
  • Loading branch information
scaleway-bot authored Jan 31, 2025
1 parent 480401b commit c99efc8
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ARGS:
[project-id] Project ID to use. If none is passed the default project ID will be used
[tags.{index}] Tags of the IP
[server] UUID of the Instance you want to attach the IP to
[type] IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated) (unknown_iptype | nat | routed_ipv4 | routed_ipv6)
[type] IP type to reserve (either 'routed_ipv4' or 'routed_ipv6') (unknown_iptype | routed_ipv4 | routed_ipv6)
[organization-id] Organization ID to use. If none is passed the default organization ID will be used
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ ARGS:
[project-id] Project ID in which the IPs are reserved
[tags] Filter IPs with these exact tags (to filter with several tags, use commas to separate them)
[name] Filter on the IP address (Works as a LIKE operation on the IP address)
[type] Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat')
[type] Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6')
[organization-id] Organization ID in which the IPs are reserved
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3 | all)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ EXAMPLES:
ARGS:
ip IP ID or IP address
[reverse] Reverse domain name
[type] Convert a 'nat' IP to a 'routed_ipv4' (unknown_iptype | nat | routed_ipv4 | routed_ipv6)
[type] Should have no effect (unknown_iptype | routed_ipv4 | routed_ipv6)
[tags.{index}] An array of keywords you want to tag this IP with
[zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | fr-par-3 | nl-ams-1 | nl-ams-2 | nl-ams-3 | pl-waw-1 | pl-waw-2 | pl-waw-3)

Expand Down
6 changes: 3 additions & 3 deletions docs/commands/instance.md
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ scw instance ip create [arg=value ...]
| project-id | | Project ID to use. If none is passed the default project ID will be used |
| tags.{index} | | Tags of the IP |
| server | | UUID of the Instance you want to attach the IP to |
| type | One of: `unknown_iptype`, `nat`, `routed_ipv4`, `routed_ipv6` | IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated) |
| type | One of: `unknown_iptype`, `routed_ipv4`, `routed_ipv6` | IP type to reserve (either 'routed_ipv4' or 'routed_ipv6') |
| organization-id | | Organization ID to use. If none is passed the default organization ID will be used |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config |

Expand Down Expand Up @@ -536,7 +536,7 @@ scw instance ip list [arg=value ...]
| project-id | | Project ID in which the IPs are reserved |
| tags | | Filter IPs with these exact tags (to filter with several tags, use commas to separate them) |
| name | | Filter on the IP address (Works as a LIKE operation on the IP address) |
| type | | Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat') |
| type | | Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6') |
| organization-id | | Organization ID in which the IPs are reserved |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3`, `all` | Zone to target. If none is passed will use default zone from the config |

Expand Down Expand Up @@ -574,7 +574,7 @@ scw instance ip update <ip ...> [arg=value ...]
|------|---|-------------|
| ip | Required | IP ID or IP address |
| reverse | | Reverse domain name |
| type | One of: `unknown_iptype`, `nat`, `routed_ipv4`, `routed_ipv6` | Convert a 'nat' IP to a 'routed_ipv4' |
| type | One of: `unknown_iptype`, `routed_ipv4`, `routed_ipv6` | Should have no effect |
| tags.{index} | | An array of keywords you want to tag this IP with |
| zone | Default: `fr-par-1`<br />One of: `fr-par-1`, `fr-par-2`, `fr-par-3`, `nl-ams-1`, `nl-ams-2`, `nl-ams-3`, `pl-waw-1`, `pl-waw-2`, `pl-waw-3` | Zone to target. If none is passed will use default zone from the config |

Expand Down
10 changes: 5 additions & 5 deletions internal/namespaces/instance/v1/instance_cli.go
Original file line number Diff line number Diff line change
Expand Up @@ -3315,7 +3315,7 @@ func instanceIPList() *core.Command {
},
{
Name: "type",
Short: `Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4', 'routed_ipv6' or 'nat')`,
Short: `Filter on the IP Mobility IP type (whose value should be either 'routed_ipv4' or 'routed_ipv6')`,
Required: false,
Deprecated: false,
Positional: false,
Expand Down Expand Up @@ -3421,11 +3421,11 @@ func instanceIPCreate() *core.Command {
},
{
Name: "type",
Short: `IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is deprecated)`,
Short: `IP type to reserve (either 'routed_ipv4' or 'routed_ipv6')`,
Required: false,
Deprecated: false,
Positional: false,
EnumValues: []string{"unknown_iptype", "nat", "routed_ipv4", "routed_ipv6"},
EnumValues: []string{"unknown_iptype", "routed_ipv4", "routed_ipv6"},
},
core.OrganizationArgSpec(),
core.ZoneArgSpec(scw.ZoneFrPar1, scw.ZoneFrPar2, scw.ZoneFrPar3, scw.ZoneNlAms1, scw.ZoneNlAms2, scw.ZoneNlAms3, scw.ZonePlWaw1, scw.ZonePlWaw2, scw.ZonePlWaw3),
Expand Down Expand Up @@ -3525,11 +3525,11 @@ func instanceIPUpdate() *core.Command {
},
{
Name: "type",
Short: `Convert a 'nat' IP to a 'routed_ipv4'`,
Short: `Should have no effect`,
Required: false,
Deprecated: false,
Positional: false,
EnumValues: []string{"unknown_iptype", "nat", "routed_ipv4", "routed_ipv6"},
EnumValues: []string{"unknown_iptype", "routed_ipv4", "routed_ipv6"},
},
{
Name: "tags.{index}",
Expand Down

0 comments on commit c99efc8

Please sign in to comment.