Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/stackit_network-area.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ stackit network-area [flags]
* [stackit network-area describe](./stackit_network-area_describe.md) - Shows details of a STACKIT Network Area
* [stackit network-area list](./stackit_network-area_list.md) - Lists all STACKIT Network Areas (SNA) of an organization
* [stackit network-area network-range](./stackit_network-area_network-range.md) - Provides functionality for network ranges in STACKIT Network Areas
* [stackit network-area region](./stackit_network-area_region.md) - Provides functionality for regional configuration of STACKIT Network Area (SNA)
* [stackit network-area route](./stackit_network-area_route.md) - Provides functionality for static routes in STACKIT Network Areas
* [stackit network-area update](./stackit_network-area_update.md) - Updates a STACKIT Network Area (SNA)

28 changes: 8 additions & 20 deletions docs/stackit_network-area_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,32 +13,20 @@ stackit network-area create [flags]
### Examples

```
Create a network area with name "network-area-1" in organization with ID "xxx" with network ranges and a transfer network
$ stackit network-area create --name network-area-1 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24"
Create a network area with name "network-area-1" in organization with ID "xxx"
$ stackit network-area create --name network-area-1 --organization-id xxx"
Create a network area with name "network-area-2" in organization with ID "xxx" with network ranges, transfer network and DNS name server
$ stackit network-area create --name network-area-2 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24" --dns-name-servers "1.1.1.1"
Create a network area with name "network-area-3" in organization with ID "xxx" with network ranges, transfer network and additional options
$ stackit network-area create --name network-area-3 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24" --default-prefix-length 25 --max-prefix-length 29 --min-prefix-length 24
Create a network area with name "network-area-1" in organization with ID "xxx" with network ranges and a transfer network and labels "key=value,key1=value1"
$ stackit network-area create --name network-area-1 --organization-id xxx --network-ranges "1.1.1.0/24,192.123.1.0/24" --transfer-network "192.160.0.0/24" --labels key=value,key1=value1
Create a network area with name "network-area-1" in organization with ID "xxx" with labels "key=value,key1=value1"
$ stackit network-area create --name network-area-1 --organization-id xxx --labels key=value,key1=value1
```

### Options

```
--default-prefix-length int The default prefix length for networks in the network area
--dns-name-servers strings List of DNS name server IPs
-h, --help Help for "stackit network-area create"
--labels stringToString Labels are key-value string pairs which can be attached to a network-area. E.g. '--labels key1=value1,key2=value2,...' (default [])
--max-prefix-length int The maximum prefix length for networks in the network area
--min-prefix-length int The minimum prefix length for networks in the network area
-n, --name string Network area name
--network-ranges strings List of network ranges (default [])
--organization-id string Organization ID
--transfer-network string Transfer network in CIDR notation
-h, --help Help for "stackit network-area create"
--labels stringToString Labels are key-value string pairs which can be attached to a network-area. E.g. '--labels key1=value1,key2=value2,...' (default [])
-n, --name string Network area name
--organization-id string Organization ID
```

### Options inherited from parent commands
Expand Down
38 changes: 38 additions & 0 deletions docs/stackit_network-area_region.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
## stackit network-area region

Provides functionality for regional configuration of STACKIT Network Area (SNA)

### Synopsis

Provides functionality for regional configuration of STACKIT Network Area (SNA).

```
stackit network-area region [flags]
```

### Options

```
-h, --help Help for "stackit network-area region"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit network-area](./stackit_network-area.md) - Provides functionality for STACKIT Network Area (SNA)
* [stackit network-area region create](./stackit_network-area_region_create.md) - Creates a new regional configuration for a STACKIT Network Area (SNA)
* [stackit network-area region delete](./stackit_network-area_region_delete.md) - Deletes a regional configuration for a STACKIT Network Area (SNA)
* [stackit network-area region describe](./stackit_network-area_region_describe.md) - Describes a regional configuration for a STACKIT Network Area (SNA)
* [stackit network-area region list](./stackit_network-area_region_list.md) - Lists all configured regions for a STACKIT Network Area (SNA)
* [stackit network-area region update](./stackit_network-area_region_update.md) - Updates a existing regional configuration for a STACKIT Network Area (SNA)

58 changes: 58 additions & 0 deletions docs/stackit_network-area_region_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
## stackit network-area region create

Creates a new regional configuration for a STACKIT Network Area (SNA)

### Synopsis

Creates a new regional configuration for a STACKIT Network Area (SNA).

```
stackit network-area region create [flags]
```

### Examples

```
Create a new regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", ipv4 network range "192.168.0.0/24" and ipv4 transfer network "192.168.1.0/24"
$ stackit network-area region create --network-area-id xxx --region eu02 --organization-id yyy --ipv4-network-ranges 192.168.0.0/24 --ipv4-transfer-network 192.168.1.0/24

Create a new regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", using the set region config
$ stackit config set --region eu02
$ stackit network-area region create --network-area-id xxx --organization-id yyy --ipv4-network-ranges 192.168.0.0/24 --ipv4-transfer-network 192.168.1.0/24

Create a new regional configuration for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", ipv4 network range "192.168.0.0/24", ipv4 transfer network "192.168.1.0/24", default prefix length "24", max prefix length "25" and min prefix length "20"
$ stackit network-area region create --network-area-id xxx --organization-id yyy --ipv4-network-ranges 192.168.0.0/24 --ipv4-transfer-network 192.168.1.0/24 --region "eu02" --ipv4-default-prefix-length 24 --ipv4-max-prefix-length 25 --ipv4-min-prefix-length 20

Create a new regional configuration for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", ipv4 network range "192.168.0.0/24", ipv4 transfer network "192.168.1.0/24", default prefix length "24", max prefix length "25" and min prefix length "20"
$ stackit network-area region create --network-area-id xxx --organization-id yyy --ipv4-network-ranges 192.168.0.0/24 --ipv4-transfer-network 192.168.1.0/24 --region "eu02" --ipv4-default-prefix-length 24 --ipv4-max-prefix-length 25 --ipv4-min-prefix-length 20
```

### Options

```
-h, --help Help for "stackit network-area region create"
--ipv4-default-nameservers strings List of default DNS name server IPs
--ipv4-default-prefix-length int The default prefix length for networks in the network area
--ipv4-max-prefix-length int The maximum prefix length for networks in the network area
--ipv4-min-prefix-length int The minimum prefix length for networks in the network area
--ipv4-network-ranges strings Network range to create in CIDR notation (default [])
--ipv4-transfer-network string Transfer network in CIDR notation
--network-area-id string STACKIT Network Area (SNA) ID
--organization-id string Organization ID
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit network-area region](./stackit_network-area_region.md) - Provides functionality for regional configuration of STACKIT Network Area (SNA)

46 changes: 46 additions & 0 deletions docs/stackit_network-area_region_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## stackit network-area region delete

Deletes a regional configuration for a STACKIT Network Area (SNA)

### Synopsis

Deletes a regional configuration for a STACKIT Network Area (SNA).

```
stackit network-area region delete [flags]
```

### Examples

```
Delete a regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy"
$ stackit network-area region delete --network-area-id xxx --region eu02 --organization-id yyy

Delete a regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", using the set region config
$ stackit config set --region eu02
$ stackit network-area region delete --network-area-id xxx --organization-id yyy
```

### Options

```
-h, --help Help for "stackit network-area region delete"
--network-area-id string STACKIT Network Area (SNA) ID
--organization-id string Organization ID
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit network-area region](./stackit_network-area_region.md) - Provides functionality for regional configuration of STACKIT Network Area (SNA)

46 changes: 46 additions & 0 deletions docs/stackit_network-area_region_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## stackit network-area region describe

Describes a regional configuration for a STACKIT Network Area (SNA)

### Synopsis

Describes a regional configuration for a STACKIT Network Area (SNA).

```
stackit network-area region describe [flags]
```

### Examples

```
Describe a regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy"
$ stackit network-area region describe --network-area-id xxx --region eu02 --organization-id yyy

Describe a regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", using the set region config
$ stackit config set --region eu02
$ stackit network-area region describe --network-area-id xxx --organization-id yyy
```

### Options

```
-h, --help Help for "stackit network-area region describe"
--network-area-id string STACKIT Network Area (SNA) ID
--organization-id string Organization ID
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit network-area region](./stackit_network-area_region.md) - Provides functionality for regional configuration of STACKIT Network Area (SNA)

42 changes: 42 additions & 0 deletions docs/stackit_network-area_region_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## stackit network-area region list

Lists all configured regions for a STACKIT Network Area (SNA)

### Synopsis

Lists all configured regions for a STACKIT Network Area (SNA).

```
stackit network-area region list [flags]
```

### Examples

```
List all configured region for a STACKIT Network Area with ID "xxx" in organization with ID "yyy"
$ stackit network-area region list --network-area-id xxx --organization-id yyy
```

### Options

```
-h, --help Help for "stackit network-area region list"
--network-area-id string STACKIT Network Area (SNA) ID
--organization-id string Organization ID
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit network-area region](./stackit_network-area_region.md) - Provides functionality for regional configuration of STACKIT Network Area (SNA)

56 changes: 56 additions & 0 deletions docs/stackit_network-area_region_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
## stackit network-area region update

Updates a existing regional configuration for a STACKIT Network Area (SNA)

### Synopsis

Updates a existing regional configuration for a STACKIT Network Area (SNA).

```
stackit network-area region update [flags]
```

### Examples

```
Update a regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy" with new ipv4-default-nameservers "8.8.8.8"
$ stackit network-area region update --network-area-id xxx --region eu02 --organization-id yyy --ipv4-default-nameservers 8.8.8.8

Update a regional configuration "eu02" for a STACKIT Network Area with ID "xxx" in organization with ID "yyy" with new ipv4-default-nameservers "8.8.8.8", using the set region config
$ stackit config set --region eu02
$ stackit network-area region update --network-area-id xxx --organization-id yyy --ipv4-default-nameservers 8.8.8.8

Update a new regional configuration for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", ipv4 network range "192.168.0.0/24", ipv4 transfer network "192.168.1.0/24", default prefix length "24", max prefix length "25" and min prefix length "20"
$ stackit network-area region update --network-area-id xxx --organization-id yyy --ipv4-network-ranges 192.168.0.0/24 --ipv4-transfer-network 192.168.1.0/24 --region "eu02" --ipv4-default-prefix-length 24 --ipv4-max-prefix-length 25 --ipv4-min-prefix-length 20

Update a new regional configuration for a STACKIT Network Area with ID "xxx" in organization with ID "yyy", ipv4 network range "192.168.0.0/24", ipv4 transfer network "192.168.1.0/24", default prefix length "24", max prefix length "25" and min prefix length "20"
$ stackit network-area region update --network-area-id xxx --organization-id yyy --ipv4-network-ranges 192.168.0.0/24 --ipv4-transfer-network 192.168.1.0/24 --region "eu02" --ipv4-default-prefix-length 24 --ipv4-max-prefix-length 25 --ipv4-min-prefix-length 20
```

### Options

```
-h, --help Help for "stackit network-area region update"
--ipv4-default-nameservers strings List of default DNS name server IPs
--ipv4-default-prefix-length int The default prefix length for networks in the network area
--ipv4-max-prefix-length int The maximum prefix length for networks in the network area
--ipv4-min-prefix-length int The minimum prefix length for networks in the network area
--network-area-id string STACKIT Network Area (SNA) ID
--organization-id string Organization ID
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--region string Target region for region-specific requests
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit network-area region](./stackit_network-area_region.md) - Provides functionality for regional configuration of STACKIT Network Area (SNA)

15 changes: 9 additions & 6 deletions docs/stackit_network-area_route_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,25 @@ stackit network-area route create [flags]
### Examples

```
Create a static route with prefix "1.1.1.0/24" and next hop "1.1.1.1" in a STACKIT Network Area with ID "xxx" in organization with ID "yyy"
$ stackit network-area route create --organization-id yyy --network-area-id xxx --prefix 1.1.1.0/24 --next-hop 1.1.1.1
Create a static route with destination "1.1.1.0/24" and next hop "1.1.1.1" in a STACKIT Network Area with ID "xxx" in organization with ID "yyy"
$ stackit network-area route create --organization-id yyy --network-area-id xxx --destination 1.1.1.0/24 --next-hop 1.1.1.1

Create a static route with labels "key:value" and "foo:bar" with prefix "1.1.1.0/24" and next hop "1.1.1.1" in a STACKIT Network Area with ID "xxx" in organization with ID "yyy"
$ stackit network-area route create --labels key=value,foo=bar --organization-id yyy --network-area-id xxx --prefix 1.1.1.0/24 --next-hop 1.1.1.1
Create a static route with labels "key:value" and "foo:bar" with destination "1.1.1.0/24" and next hop "1.1.1.1" in a STACKIT Network Area with ID "xxx" in organization with ID "yyy"
$ stackit network-area route create --labels key=value,foo=bar --organization-id yyy --network-area-id xxx --destination 1.1.1.0/24 --next-hop 1.1.1.1
```

### Options

```
--destination string Destination route. Must be a valid IPv4 or IPv6 CIDR
-h, --help Help for "stackit network-area route create"
--labels stringToString Labels are key-value string pairs which can be attached to a route. A label can be provided with the format key=value and the flag can be used multiple times to provide a list of labels (default [])
--network-area-id string STACKIT Network Area ID
--next-hop string Next hop IP address. Must be a valid IPv4
--next-hop-ipv4 string Next hop IPv4 address
--next-hop-ipv6 string Next hop IPv6 address
--nexthop-blackhole Sets next hop to black hole
--nexthop-internet Sets next hop to internet
--organization-id string Organization ID
--prefix string Static route prefix
```

### Options inherited from parent commands
Expand Down
Loading
Loading