Skip to content
This repository has been archived by the owner on Mar 6, 2024. It is now read-only.

Fix arg names for dhcp pool crete, update docs #549

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
77 changes: 76 additions & 1 deletion docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@
<a href="vcd_catalog_upload">upload</a></li>
</ul></li>
<li>
<a href="vcd_datastore">datastore</a><ul><li>
<a href="vcd_datastore_list">list</a></li>
</ul></li>
<li>
<a href="vcd_disk">disk</a><ul><li>
<a href="vcd_disk_change-owner">change-owner</a></li><li>
<a href="vcd_disk_create">create</a></li><li>
Expand Down Expand Up @@ -259,6 +263,7 @@
<li>
<a href="vcd_role">role</a><ul><li>
<a href="vcd_role_add-right">add-right</a></li><li>
<a href="vcd_role_clone">clone</a></li><li>
<a href="vcd_role_create">create</a></li><li>
<a href="vcd_role_delete">delete</a></li><li>
<a href="vcd_role_info">info</a></li><li>
Expand Down Expand Up @@ -312,6 +317,7 @@
<li>
<a href="vcd_vapp_add-disk">add-disk</a></li><li>
<a href="vcd_vapp_add-vm">add-vm</a></li><li>
<a href="vcd_vapp_add-vm-scratch">add-vm-scratch</a></li><li>
<a href="vcd_vapp_attach">attach</a></li><li>
<a href="vcd_vapp_capture">capture</a></li><li>
<a href="vcd_vapp_change-owner">change-owner</a></li><li>
Expand All @@ -322,9 +328,11 @@
<a href="vcd_vapp_delete">delete</a></li><li>
<a href="vcd_vapp_deploy">deploy</a></li><li>
<a href="vcd_vapp_detach">detach</a></li><li>
<a href="vcd_vapp_disable-download">disable-download</a></li><li>
<a href="vcd_vapp_discard-suspended-state">discard-suspended-state</a></li><li>
<a href="vcd_vapp_disconnect">disconnect</a></li><li>
<a href="vcd_vapp_download">download</a></li><li>
<a href="vcd_vapp_enable-download">enable-download</a></li><li>
<a href="vcd_vapp_enter-maintenance-mode">enter-maintenance-mode</a></li><li>
<a href="vcd_vapp_exit-maintenance-mode">exit-maintenance-mode</a></li><li>
<a href="vcd_vapp_info">info</a></li><li>
Expand All @@ -335,11 +343,14 @@
<a href="vcd_vapp_network_add-ip-range">add-ip-range</a></li><li>
<a href="vcd_vapp_network_connect-ovdc">connect-ovdc</a></li><li>
<a href="vcd_vapp_network_create">create</a></li><li>
<a href="vcd_vapp_network_create-ovdc-network">create-ovdc-network</a></li><li>
<a href="vcd_vapp_network_delete">delete</a></li><li>
<a href="vcd_vapp_network_delete-ip-range">delete-ip-range</a></li><li>
<a href="vcd_vapp_network_dns-info">dns-info</a></li><li>
<a href="vcd_vapp_network_enable-fence">enable-fence</a></li><li>
<a href="vcd_vapp_network_list">list</a></li><li>
<a href="vcd_vapp_network_list-allocated-ip">list-allocated-ip</a></li><li>
<a href="vcd_vapp_network_list-vm-interface">list-vm-interface</a></li><li>
<a href="vcd_vapp_network_reset">reset</a></li><li>
<a href="vcd_vapp_network_services">services</a><ul><li>
<a href="vcd_vapp_network_services_dhcp">dhcp</a><ul><li>
Expand All @@ -348,7 +359,30 @@
</ul></li>
<li>
<a href="vcd_vapp_network_services_firewall">firewall</a><ul><li>
<a href="vcd_vapp_network_services_firewall_enable-firewall">enable-firewall</a></li>
<a href="vcd_vapp_network_services_firewall_add">add</a></li><li>
<a href="vcd_vapp_network_services_firewall_delete">delete</a></li><li>
<a href="vcd_vapp_network_services_firewall_enable-firewall">enable-firewall</a></li><li>
<a href="vcd_vapp_network_services_firewall_list">list</a></li><li>
<a href="vcd_vapp_network_services_firewall_set-default-action">set-default-action</a></li><li>
<a href="vcd_vapp_network_services_firewall_update">update</a></li>
</ul></li>
<li>
<a href="vcd_vapp_network_services_nat">nat</a><ul><li>
<a href="vcd_vapp_network_services_nat_add">add</a></li><li>
<a href="vcd_vapp_network_services_nat_delete">delete</a></li><li>
<a href="vcd_vapp_network_services_nat_enable-nat">enable-nat</a></li><li>
<a href="vcd_vapp_network_services_nat_get-nat-type">get-nat-type</a></li><li>
<a href="vcd_vapp_network_services_nat_list">list</a></li><li>
<a href="vcd_vapp_network_services_nat_set-nat-type">set-nat-type</a></li><li>
<a href="vcd_vapp_network_services_nat_update">update</a></li>
</ul></li>
<li>
<a href="vcd_vapp_network_services_static-route">static-route</a><ul><li>
<a href="vcd_vapp_network_services_static-route_add">add</a></li><li>
<a href="vcd_vapp_network_services_static-route_delete">delete</a></li><li>
<a href="vcd_vapp_network_services_static-route_enable-service">enable-service</a></li><li>
<a href="vcd_vapp_network_services_static-route_list">list</a></li><li>
<a href="vcd_vapp_network_services_static-route_update">update</a></li>
</ul></li>
</ul></li>
<li>
Expand All @@ -364,12 +398,18 @@
<a href="vcd_vapp_remove-snapshot">remove-snapshot</a></li><li>
<a href="vcd_vapp_reset">reset</a></li><li>
<a href="vcd_vapp_revert-to-snapshot">revert-to-snapshot</a></li><li>
<a href="vcd_vapp_show-lease">show-lease</a></li><li>
<a href="vcd_vapp_show-metadata">show-metadata</a></li><li>
<a href="vcd_vapp_show-product-section">show-product-section</a></li><li>
<a href="vcd_vapp_show-startup-section">show-startup-section</a></li><li>
<a href="vcd_vapp_shutdown">shutdown</a></li><li>
<a href="vcd_vapp_stop">stop</a></li><li>
<a href="vcd_vapp_suspend">suspend</a></li><li>
<a href="vcd_vapp_undeploy">undeploy</a></li><li>
<a href="vcd_vapp_update">update</a></li><li>
<a href="vcd_vapp_update-lease">update-lease</a></li><li>
<a href="vcd_vapp_update-product-section">update-product-section</a></li><li>
<a href="vcd_vapp_update-startup-section">update-startup-section</a></li><li>
<a href="vcd_vapp_upgrade-virtual-hardware">upgrade-virtual-hardware</a></li><li>
<a href="vcd_vapp_use">use</a></li>
</ul></li>
Expand Down Expand Up @@ -399,6 +439,8 @@
<a href="vcd_vdc_enable">enable</a></li><li>
<a href="vcd_vdc_info">info</a></li><li>
<a href="vcd_vdc_list">list</a></li><li>
<a href="vcd_vdc_list-disk">list-disk</a></li><li>
<a href="vcd_vdc_list-media">list-media</a></li><li>
<a href="vcd_vdc_use">use</a></li>
</ul></li>
<li>
Expand All @@ -407,6 +449,7 @@
<a href="vcd_vm_add-nic">add-nic</a></li><li>
<a href="vcd_vm_attach-disk">attach-disk</a></li><li>
<a href="vcd_vm_check-compliance">check-compliance</a></li><li>
<a href="vcd_vm_check-post-gc-script">check-post-gc-script</a></li><li>
<a href="vcd_vm_consolidate">consolidate</a></li><li>
<a href="vcd_vm_copy">copy</a></li><li>
<a href="vcd_vm_create-snapshot">create-snapshot</a></li><li>
Expand All @@ -417,24 +460,56 @@
<a href="vcd_vm_detach-disk">detach-disk</a></li><li>
<a href="vcd_vm_discard-suspend">discard-suspend</a></li><li>
<a href="vcd_vm_eject-cd">eject-cd</a></li><li>
<a href="vcd_vm_enable-nested-hypervisor">enable-nested-hypervisor</a></li><li>
<a href="vcd_vm_gc-enable">gc-enable</a></li><li>
<a href="vcd_vm_gc-status">gc-status</a></li><li>
<a href="vcd_vm_general-setting">general-setting</a></li><li>
<a href="vcd_vm_get-compliance-result">get-compliance-result</a></li><li>
<a href="vcd_vm_info">info</a></li><li>
<a href="vcd_vm_insert-cd">insert-cd</a></li><li>
<a href="vcd_vm_install-vmware-tools">install-vmware-tools</a></li><li>
<a href="vcd_vm_list">list</a></li><li>
<a href="vcd_vm_list-boot-options">list-boot-options</a></li><li>
<a href="vcd_vm_list-current-metrics">list-current-metrics</a></li><li>
<a href="vcd_vm_list-gc-section">list-gc-section</a></li><li>
<a href="vcd_vm_list-historic-metrics">list-historic-metrics</a></li><li>
<a href="vcd_vm_list-metadata">list-metadata</a></li><li>
<a href="vcd_vm_list-mks-ticket">list-mks-ticket</a></li><li>
<a href="vcd_vm_list-nics">list-nics</a></li><li>
<a href="vcd_vm_list-os-section">list-os-section</a></li><li>
<a href="vcd_vm_list-product-sections">list-product-sections</a></li><li>
<a href="vcd_vm_list-runtime-info">list-runtime-info</a></li><li>
<a href="vcd_vm_list-sample-historic-data">list-sample-historic-data</a></li><li>
<a href="vcd_vm_list-screen-ticket">list-screen-ticket</a></li><li>
<a href="vcd_vm_list-storage-profile">list-storage-profile</a></li><li>
<a href="vcd_vm_list-subset-current-metrics">list-subset-current-metrics</a></li><li>
<a href="vcd_vm_list-virtual-hardware-section">list-virtual-hardware-section</a></li><li>
<a href="vcd_vm_list-vm-capabilities">list-vm-capabilities</a></li><li>
<a href="vcd_vm_move">move</a></li><li>
<a href="vcd_vm_power-off">power-off</a></li><li>
<a href="vcd_vm_power-on">power-on</a></li><li>
<a href="vcd_vm_poweron-force-recustomize">poweron-force-recustomize</a></li><li>
<a href="vcd_vm_reboot">reboot</a></li><li>
<a href="vcd_vm_reload-from-vc">reload-from-vc</a></li><li>
<a href="vcd_vm_relocate">relocate</a></li><li>
<a href="vcd_vm_remove-metadata">remove-metadata</a></li><li>
<a href="vcd_vm_remove-snapshot">remove-snapshot</a></li><li>
<a href="vcd_vm_reset">reset</a></li><li>
<a href="vcd_vm_revert-to-snapshot">revert-to-snapshot</a></li><li>
<a href="vcd_vm_set-metadata">set-metadata</a></li><li>
<a href="vcd_vm_shutdown">shutdown</a></li><li>
<a href="vcd_vm_suspend">suspend</a></li><li>
<a href="vcd_vm_undeploy">undeploy</a></li><li>
<a href="vcd_vm_update">update</a></li><li>
<a href="vcd_vm_update-boot-options">update-boot-options</a></li><li>
<a href="vcd_vm_update-gc-section">update-gc-section</a></li><li>
<a href="vcd_vm_update-general-setting">update-general-setting</a></li><li>
<a href="vcd_vm_update-metadata">update-metadata</a></li><li>
<a href="vcd_vm_update-nic">update-nic</a></li><li>
<a href="vcd_vm_update-os-section">update-os-section</a></li><li>
<a href="vcd_vm_update-vhs-disk">update-vhs-disk</a></li><li>
<a href="vcd_vm_update-vhs-media">update-vhs-media</a></li><li>
<a href="vcd_vm_update-vm-capabilities">update-vm-capabilities</a></li><li>
<a href="vcd_vm_upgrade-virtual-hardware">upgrade-virtual-hardware</a></li></ul>
</li></ul>
</li></ul>
Expand Down
51 changes: 26 additions & 25 deletions docs/vcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,30 +19,31 @@ Options:
-h, --help Show this message and exit.

Commands:
catalog work with catalogs
disk manage independent disks
gateway manage edge gateways
help show help
info show resource details
login login to vCD
logout logout from vCD
netpool work with network pools
network work with vcd networks
nsxt manage NSX-T managers
org work with organizations
profile manage profiles
pvdc work with provider virtual datacenters
pwd current resources in use
right work with rights
role work with roles
search search resources
system manage system settings
task work with tasks
user work with users in current organization
vapp manage vApps
vc manage vCenter Servers
vdc work with virtual datacenters
version show version
vm manage VMs
catalog work with catalogs
datastore manage datastores
disk manage independent disks
gateway manage edge gateways
help show help
info show resource details
login login to vCD
logout logout from vCD
netpool work with network pools
network work with vcd networks
nsxt manage NSX-T managers
org work with organizations
profile manage profiles
pvdc work with provider virtual datacenters
pwd current resources in use
right work with rights
role work with roles
search search resources
system manage system settings
task work with tasks
user work with users in current organization
vapp manage vApps
vc manage vCenter Servers
vdc work with virtual datacenters
version show version
vm manage VMs

```
1 change: 1 addition & 0 deletions docs/vcd_catalog_acl_share.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Usage: vcd catalog acl share [OPTIONS] <catalog-name>
Options:
--access-level <access-level> access level at which the catalog is shared.
ReadOnly by default

-h, --help Show this message and exit.

```
18 changes: 18 additions & 0 deletions docs/vcd_datastore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```
Usage: vcd datastore [OPTIONS] COMMAND [ARGS]...

Manage datastores in vCloud Director.

Examples
vcd datastore list
Get list of datastores attached to the vCD system.



Options:
-h, --help Show this message and exit.

Commands:
list list datastores

```
7 changes: 7 additions & 0 deletions docs/vcd_datastore_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
```
Usage: vcd datastore list [OPTIONS]

Options:
-h, --help Show this message and exit.

```
1 change: 1 addition & 0 deletions docs/vcd_disk_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Options:
Description of the new disk
-s, --storage-profile <name> Name of the Storage Profile to be used for
the new disk.

-i, --iops <iops> Iops requirements of the new disk
-h, --help Show this message and exit.

Expand Down
1 change: 1 addition & 0 deletions docs/vcd_disk_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Options:
New Description of the disk
-S, --storage-profile <name> Name of the new Storage Profile to be used
for the disk.

-i, --iops <iops> New iops requirement of the disk
-h, --help Show this message and exit.

Expand Down
1 change: 1 addition & 0 deletions docs/vcd_gateway_configure-default-gateway_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Options:
-e, --external-network <external network>
external network connected to the gateway.
[required]

-i, --gateway-ip <ip> IP of the gateway. [required]
--enable / --disable enables/disables the default gateway
-h, --help Show this message and exit.
Expand Down
1 change: 1 addition & 0 deletions docs/vcd_gateway_configure-external-network_add.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Options:
-e, --external-network <external network>
external network to which the gateway can
connect. [required]

--configure-ip-setting <subnet> <configured IP>
configuring multiple IP settings
-h, --help Show this message and exit.
Expand Down
1 change: 1 addition & 0 deletions docs/vcd_gateway_configure-external-network_remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Options:
-e, --external-network <external network>
external network that needs to be removed
from the gateway. [required]

-h, --help Show this message and exit.

```
1 change: 1 addition & 0 deletions docs/vcd_gateway_configure-ip-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Options:
-e, --external-network <external network>
external networks to which the new gateway
can connect. [required]

-s, --subnet-available <subnet> <enable> <ip>
set the subnet settings [required]
-h, --help Show this message and exit.
Expand Down
1 change: 1 addition & 0 deletions docs/vcd_gateway_configure-rate-limits_disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Options:
-e, --external-network <external network>
external network connected to the gateway.
[required]

-h, --help Show this message and exit.

```
8 changes: 8 additions & 0 deletions docs/vcd_gateway_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,16 @@ Options:
-e, --external-network <external network>
list of external networks to which the new
gateway can connect. [required]

--description <description> description
--default-gateway <external_network>
name of external network for default gateway
configuration

--default-gateway-ip <default gateway IP>
IP from the external network for the default
gateway

--dns-relay-enabled / --dns-relay-disabled
DNS relay enabled/disabled
-c, --gateway-config <gateway_config>
Expand All @@ -22,19 +25,24 @@ Options:
--distributed-routing-enabled / --distributed-routing-disabled
enable distributed routing for networks
connected to this gateway.

--configure-ip-setting <external network> <subnet> <configured IP>
configuring multiple ip settings
--sub-allocate-ip <external network>
sub-allocate the IP Pools provided by the
externally connected interfaces

--subnet <external network subnet>
subnet for the selected external network for
IP sub allocation

--ip-range <IP ranges> IP ranges pertaining to external network's
IP Pool

--configure-rate-limit <external network> <incoming rate limit> <outgoing rate limit>
specify the inbound and outbound rate limits
for each externally connected interface.

--flip-flop-enabled / --flip-flop-disabled
flip flip mode
--gateway-type NSXV_BACKED/NSXT_BACKED/NSXT_IMPORTED
Expand Down
1 change: 1 addition & 0 deletions docs/vcd_gateway_enable-distributed-routing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ Usage: vcd gateway enable-distributed-routing [OPTIONS] <gateway name>
Options:
--enable / --disable Enable distributed routing for networks connected to
this gateway.

-h, --help Show this message and exit.

```
10 changes: 5 additions & 5 deletions docs/vcd_gateway_services_dhcp-pool_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ Options:
IP range of the DHCP pool [required]
--enable-auto-dns / --disable-auto-dns
Auto configure DNS
-g--gateway-ip <default-gateway-ip>
-g, --gateway-ip <default-gateway-ip>
Default gateway ip
-d--domain <domain-name> domain name
-p--primary-server <primary-name-server>
-d, --domain <domain-name> domain name
-p, --primary-server <primary-name-server>
primary server ip
-s--secondary-server <secondary-name-server>
-s, --secondary-server <secondary-name-server>
secondary server ip
-l--lease <lease-time> lease time
-l, --lease <lease-time> lease time
--never-expire-lease / --expire-lease
lease lease expire
--subnet <subnet> subnet mask
Expand Down
Loading