Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
simonfuhrer committed Mar 9, 2022
1 parent 006658e commit 40497bf
Show file tree
Hide file tree
Showing 24 changed files with 560 additions and 2 deletions.
3 changes: 3 additions & 0 deletions docs/nutactl.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,14 @@ A command-line interface for nutanix prism central
* [nutactl cluster](nutactl_cluster.md) - Manage cluster
* [nutactl completion](nutactl_completion.md) - Generates bash completion scripts
* [nutactl context](nutactl_context.md) - Manage contexts
* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs
* [nutactl host](nutactl_host.md) - Manage hosts
* [nutactl image](nutactl_image.md) - Manage images
* [nutactl project](nutactl_project.md) - Manage projects
* [nutactl routing-policy](nutactl_routing-policy.md) - Manage routing policies
* [nutactl subnet](nutactl_subnet.md) - Manage subnets
* [nutactl task](nutactl_task.md) - Manage tasks
* [nutactl version](nutactl_version.md) - Print version information
* [nutactl vm](nutactl_vm.md) - Manage vms
* [nutactl vpc](nutactl_vpc.md) - Manage vpcs

34 changes: 34 additions & 0 deletions docs/nutactl_floatingip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## nutactl floatingip

Manage vpcs

```
nutactl floatingip
```

### Options

```
-h, --help help for floatingip
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl](nutactl.md) - nutanix prism central CLI
* [nutactl floatingip assign](nutactl_floatingip_assign.md) - Assign a Floating IP to a vm
* [nutactl floatingip create](nutactl_floatingip_create.md) - Create a Floating IP
* [nutactl floatingip delete](nutactl_floatingip_delete.md) - Delete a Floating IP
* [nutactl floatingip describe](nutactl_floatingip_describe.md) - Describe a Floating IP
* [nutactl floatingip list](nutactl_floatingip_list.md) - List Floating IPs
* [nutactl floatingip release](nutactl_floatingip_release.md) - Release a Floating IP
* [nutactl floatingip update](nutactl_floatingip_update.md) - Update a Floating IP

28 changes: 28 additions & 0 deletions docs/nutactl_floatingip_assign.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## nutactl floatingip assign

Assign a Floating IP to a vm

```
nutactl floatingip assign [FLAGS] FLOATINGIP
```

### Options

```
-h, --help help for assign
--vm string vm name or uuid
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs

28 changes: 28 additions & 0 deletions docs/nutactl_floatingip_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## nutactl floatingip create

Create a Floating IP

```
nutactl floatingip create [FLAGS] External Subnet Name or Uuid
```

### Options

```
-h, --help help for create
--vm string vm name or uuid to attach
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs

27 changes: 27 additions & 0 deletions docs/nutactl_floatingip_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## nutactl floatingip delete

Delete a Floating IP

```
nutactl floatingip delete [FLAGS] FLOATING IP
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs

28 changes: 28 additions & 0 deletions docs/nutactl_floatingip_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## nutactl floatingip describe

Describe a Floating IP

```
nutactl floatingip describe [FLAGS] FLOATINGIP
```

### Options

```
-h, --help help for describe
-o, --output string json|yaml|table (default "json")
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs

29 changes: 29 additions & 0 deletions docs/nutactl_floatingip_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
## nutactl floatingip list

List Floating IPs

```
nutactl floatingip list [FLAGS]
```

### Options

```
-f, --filter string FIQL filter (e.g.)
-h, --help help for list
-o, --output string json|yaml|table (default "table")
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs

27 changes: 27 additions & 0 deletions docs/nutactl_floatingip_release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## nutactl floatingip release

Release a Floating IP

```
nutactl floatingip release [FLAGS] FLOATINGIP
```

### Options

```
-h, --help help for release
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs

27 changes: 27 additions & 0 deletions docs/nutactl_floatingip_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## nutactl floatingip update

Update a Floating IP

```
nutactl floatingip update [FLAGS] FLOATINGIP
```

### Options

```
-h, --help help for update
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl floatingip](nutactl_floatingip.md) - Manage vpcs

31 changes: 31 additions & 0 deletions docs/nutactl_routing-policy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
## nutactl routing-policy

Manage routing policies

```
nutactl routing-policy
```

### Options

```
-h, --help help for routing-policy
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl](nutactl.md) - nutanix prism central CLI
* [nutactl routing-policy create](nutactl_routing-policy_create.md) - Create a routing policy
* [nutactl routing-policy delete](nutactl_routing-policy_delete.md) - Delete a Routing Policy
* [nutactl routing-policy describe](nutactl_routing-policy_describe.md) - Describe a routing policy
* [nutactl routing-policy list](nutactl_routing-policy_list.md) - List routing policies

34 changes: 34 additions & 0 deletions docs/nutactl_routing-policy_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## nutactl routing-policy create

Create a routing policy

```
nutactl routing-policy create [FLAGS] routing policy
```

### Options

```
--action string PERMIT or DENY (default "PERMIT")
--destination string ALL, INTERNET or CIDR
-h, --help help for create
--isbidirectional Additionally Create Policy in reverse direction
--priority int32 priority of rule (between 10-1000
--protocol-type string any of 'ALL', 'TCP', 'UDP', 'ICMP', 'PROTOCOL_NUMBER' (default "ALL")
--source string ALL, INTERNET or CIDR
--vpc string vpc uuid or name
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl routing-policy](nutactl_routing-policy.md) - Manage routing policies

27 changes: 27 additions & 0 deletions docs/nutactl_routing-policy_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## nutactl routing-policy delete

Delete a Routing Policy

```
nutactl routing-policy delete [FLAGS] Routing Policy
```

### Options

```
-h, --help help for delete
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl routing-policy](nutactl_routing-policy.md) - Manage routing policies

28 changes: 28 additions & 0 deletions docs/nutactl_routing-policy_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## nutactl routing-policy describe

Describe a routing policy

```
nutactl routing-policy describe [FLAGS] ROUTING-POLICY
```

### Options

```
-h, --help help for describe
-o, --output string json|yaml|table (default "json")
```

### Options inherited from parent commands

```
--config string config file to use (default $HOME/.nutactl.yaml)
--insecure Accept insecure TLS certificates
--log-json log as json
--log-level string log level (trace,debug,info,warn/warning,error,fatal,panic) (default "info")
```

### SEE ALSO

* [nutactl routing-policy](nutactl_routing-policy.md) - Manage routing policies

Loading

0 comments on commit 40497bf

Please sign in to comment.