From f52201a817775adc9779fa5418e66cf8f8b135c4 Mon Sep 17 00:00:00 2001 From: Konrad Gawda Date: Mon, 22 Mar 2021 16:32:39 +0100 Subject: [PATCH] Fix arg names for dhcp pool crete Add missing commas in command line arguments definition. Thanks to this, eg.: -g and --gateway-ip are separate options, instead of -g--gateway-ip. Also re-generate docs to reflect changes. Signed-off-by: Konrad Gawda --- docs/commands.md | 77 +++++- docs/vcd.md | 51 ++-- docs/vcd_catalog_acl_share.md | 1 + docs/vcd_datastore.md | 18 ++ docs/vcd_datastore_list.md | 7 + docs/vcd_disk_create.md | 1 + docs/vcd_disk_update.md | 1 + ...ateway_configure-default-gateway_update.md | 1 + ..._gateway_configure-external-network_add.md | 1 + ...teway_configure-external-network_remove.md | 1 + docs/vcd_gateway_configure-ip-settings.md | 1 + ...d_gateway_configure-rate-limits_disable.md | 1 + docs/vcd_gateway_create.md | 8 + .../vcd_gateway_enable-distributed-routing.md | 1 + docs/vcd_gateway_services_dhcp-pool_create.md | 10 +- docs/vcd_gateway_services_firewall.md | 1 + ...way_services_firewall_list-object-types.md | 1 + ..._gateway_services_firewall_list-objects.md | 1 + docs/vcd_gateway_services_firewall_update.md | 2 + docs/vcd_gateway_services_ipsec-vpn.md | 1 + docs/vcd_gateway_services_ipsec-vpn_create.md | 4 + docs/vcd_gateway_services_ipsec-vpn_update.md | 2 + docs/vcd_gateway_sub-allocate-ip_add.md | 2 + docs/vcd_gateway_sub-allocate-ip_remove.md | 2 + docs/vcd_gateway_sub-allocate-ip_update.md | 3 + docs/vcd_login.md | 3 +- docs/vcd_network_direct_create.md | 2 + docs/vcd_network_external.md | 3 + docs/vcd_network_external_add-subnet.md | 1 + docs/vcd_network_external_create.md | 3 + docs/vcd_network_external_update-ip-range.md | 2 + docs/vcd_network_isolated_create.md | 7 + docs/vcd_network_routed.md | 3 + docs/vcd_network_routed_create.md | 1 + docs/vcd_network_routed_edit.md | 1 + docs/vcd_network_routed_update-ip-range.md | 2 + docs/vcd_nsxt_register.md | 1 + docs/vcd_org_delete.md | 2 + docs/vcd_pvdc_create.md | 5 + docs/vcd_role.md | 9 +- docs/vcd_role_clone.md | 12 + docs/vcd_user_create.md | 3 + docs/vcd_vapp.md | 41 +++ docs/vcd_vapp_acl_share.md | 1 + docs/vcd_vapp_add-vm-scratch.md | 25 ++ docs/vcd_vapp_add-vm.md | 1 + docs/vcd_vapp_connect.md | 2 + docs/vcd_vapp_copy.md | 1 + docs/vcd_vapp_deploy.md | 2 + docs/vcd_vapp_disable-download.md | 7 + docs/vcd_vapp_enable-download.md | 7 + docs/vcd_vapp_network.md | 12 + docs/vcd_vapp_network_create-ovdc-network.md | 8 + docs/vcd_vapp_network_enable-fence.md | 7 + docs/vcd_vapp_network_list-vm-interface.md | 7 + docs/vcd_vapp_network_services.md | 6 +- docs/vcd_vapp_network_services_dhcp_set.md | 1 + docs/vcd_vapp_network_services_firewall.md | 31 ++- .../vcd_vapp_network_services_firewall_add.md | 20 ++ ...d_vapp_network_services_firewall_delete.md | 9 + ...twork_services_firewall_enable-firewall.md | 2 +- ...vcd_vapp_network_services_firewall_list.md | 8 + ...rk_services_firewall_set-default-action.md | 11 + ...d_vapp_network_services_firewall_update.md | 22 ++ docs/vcd_vapp_network_services_nat.md | 64 +++++ docs/vcd_vapp_network_services_nat_add.md | 15 ++ docs/vcd_vapp_network_services_nat_delete.md | 8 + ...cd_vapp_network_services_nat_enable-nat.md | 9 + ..._vapp_network_services_nat_get-nat-type.md | 8 + docs/vcd_vapp_network_services_nat_list.md | 7 + ..._vapp_network_services_nat_set-nat-type.md | 10 + docs/vcd_vapp_network_services_nat_update.md | 15 ++ .../vcd_vapp_network_services_static-route.md | 44 ++++ ..._vapp_network_services_static-route_add.md | 11 + ...pp_network_services_static-route_delete.md | 9 + ...rk_services_static-route_enable-service.md | 9 + ...vapp_network_services_static-route_list.md | 8 + ...pp_network_services_static-route_update.md | 12 + docs/vcd_vapp_network_update-ip-range.md | 2 + docs/vcd_vapp_show-lease.md | 7 + docs/vcd_vapp_show-metadata.md | 7 + docs/vcd_vapp_show-product-section.md | 7 + docs/vcd_vapp_show-startup-section.md | 7 + docs/vcd_vapp_update-product-section.md | 23 ++ docs/vcd_vapp_update-startup-section.md | 12 + docs/vcd_vc_attach.md | 4 + docs/vcd_vdc.md | 36 ++- docs/vcd_vdc_create.md | 6 + docs/vcd_vdc_list-disk.md | 7 + docs/vcd_vdc_list-media.md | 7 + docs/vcd_vm.md | 240 +++++++++++++++--- docs/vcd_vm_add-nic.md | 3 + docs/vcd_vm_check-post-gc-script.md | 7 + docs/vcd_vm_eject-cd.md | 4 +- docs/vcd_vm_enable-nested-hypervisor.md | 7 + docs/vcd_vm_gc-enable.md | 8 + docs/vcd_vm_gc-status.md | 7 + docs/vcd_vm_get-compliance-result.md | 7 + docs/vcd_vm_insert-cd.md | 4 +- docs/vcd_vm_list-boot-options.md | 7 + docs/vcd_vm_list-current-metrics.md | 7 + docs/vcd_vm_list-gc-section.md | 7 + docs/vcd_vm_list-historic-metrics.md | 7 + docs/vcd_vm_list-metadata.md | 7 + docs/vcd_vm_list-mks-ticket.md | 7 + docs/vcd_vm_list-os-section.md | 7 + docs/vcd_vm_list-product-sections.md | 7 + docs/vcd_vm_list-runtime-info.md | 7 + docs/vcd_vm_list-sample-historic-data.md | 10 + docs/vcd_vm_list-screen-ticket.md | 7 + docs/vcd_vm_list-subset-current-metrics.md | 11 + docs/vcd_vm_list-virtual-hardware-section.md | 14 + docs/vcd_vm_list-vm-capabilities.md | 7 + docs/vcd_vm_poweron-force-recustomize.md | 7 + docs/vcd_vm_relocate.md | 8 + docs/vcd_vm_remove-metadata.md | 9 + docs/vcd_vm_remove-snapshot.md | 7 + docs/vcd_vm_set-metadata.md | 12 + docs/vcd_vm_update-boot-options.md | 10 + docs/vcd_vm_update-gc-section.md | 28 ++ docs/vcd_vm_update-general-setting.md | 13 + docs/vcd_vm_update-metadata.md | 12 + docs/vcd_vm_update-nic.md | 20 ++ docs/vcd_vm_update-os-section.md | 9 + docs/vcd_vm_update-vhs-disk.md | 10 + docs/vcd_vm_update-vhs-media.md | 10 + docs/vcd_vm_update-vm-capabilities.md | 11 + vcd_cli/dhcp_pool.py | 10 +- 128 files changed, 1325 insertions(+), 94 deletions(-) create mode 100644 docs/vcd_datastore.md create mode 100644 docs/vcd_datastore_list.md create mode 100644 docs/vcd_role_clone.md create mode 100644 docs/vcd_vapp_add-vm-scratch.md create mode 100644 docs/vcd_vapp_disable-download.md create mode 100644 docs/vcd_vapp_enable-download.md create mode 100644 docs/vcd_vapp_network_create-ovdc-network.md create mode 100644 docs/vcd_vapp_network_enable-fence.md create mode 100644 docs/vcd_vapp_network_list-vm-interface.md create mode 100644 docs/vcd_vapp_network_services_firewall_add.md create mode 100644 docs/vcd_vapp_network_services_firewall_delete.md create mode 100644 docs/vcd_vapp_network_services_firewall_list.md create mode 100644 docs/vcd_vapp_network_services_firewall_set-default-action.md create mode 100644 docs/vcd_vapp_network_services_firewall_update.md create mode 100644 docs/vcd_vapp_network_services_nat.md create mode 100644 docs/vcd_vapp_network_services_nat_add.md create mode 100644 docs/vcd_vapp_network_services_nat_delete.md create mode 100644 docs/vcd_vapp_network_services_nat_enable-nat.md create mode 100644 docs/vcd_vapp_network_services_nat_get-nat-type.md create mode 100644 docs/vcd_vapp_network_services_nat_list.md create mode 100644 docs/vcd_vapp_network_services_nat_set-nat-type.md create mode 100644 docs/vcd_vapp_network_services_nat_update.md create mode 100644 docs/vcd_vapp_network_services_static-route.md create mode 100644 docs/vcd_vapp_network_services_static-route_add.md create mode 100644 docs/vcd_vapp_network_services_static-route_delete.md create mode 100644 docs/vcd_vapp_network_services_static-route_enable-service.md create mode 100644 docs/vcd_vapp_network_services_static-route_list.md create mode 100644 docs/vcd_vapp_network_services_static-route_update.md create mode 100644 docs/vcd_vapp_show-lease.md create mode 100644 docs/vcd_vapp_show-metadata.md create mode 100644 docs/vcd_vapp_show-product-section.md create mode 100644 docs/vcd_vapp_show-startup-section.md create mode 100644 docs/vcd_vapp_update-product-section.md create mode 100644 docs/vcd_vapp_update-startup-section.md create mode 100644 docs/vcd_vdc_list-disk.md create mode 100644 docs/vcd_vdc_list-media.md create mode 100644 docs/vcd_vm_check-post-gc-script.md create mode 100644 docs/vcd_vm_enable-nested-hypervisor.md create mode 100644 docs/vcd_vm_gc-enable.md create mode 100644 docs/vcd_vm_gc-status.md create mode 100644 docs/vcd_vm_get-compliance-result.md create mode 100644 docs/vcd_vm_list-boot-options.md create mode 100644 docs/vcd_vm_list-current-metrics.md create mode 100644 docs/vcd_vm_list-gc-section.md create mode 100644 docs/vcd_vm_list-historic-metrics.md create mode 100644 docs/vcd_vm_list-metadata.md create mode 100644 docs/vcd_vm_list-mks-ticket.md create mode 100644 docs/vcd_vm_list-os-section.md create mode 100644 docs/vcd_vm_list-product-sections.md create mode 100644 docs/vcd_vm_list-runtime-info.md create mode 100644 docs/vcd_vm_list-sample-historic-data.md create mode 100644 docs/vcd_vm_list-screen-ticket.md create mode 100644 docs/vcd_vm_list-subset-current-metrics.md create mode 100644 docs/vcd_vm_list-virtual-hardware-section.md create mode 100644 docs/vcd_vm_list-vm-capabilities.md create mode 100644 docs/vcd_vm_poweron-force-recustomize.md create mode 100644 docs/vcd_vm_relocate.md create mode 100644 docs/vcd_vm_remove-metadata.md create mode 100644 docs/vcd_vm_remove-snapshot.md create mode 100644 docs/vcd_vm_set-metadata.md create mode 100644 docs/vcd_vm_update-boot-options.md create mode 100644 docs/vcd_vm_update-gc-section.md create mode 100644 docs/vcd_vm_update-general-setting.md create mode 100644 docs/vcd_vm_update-metadata.md create mode 100644 docs/vcd_vm_update-nic.md create mode 100644 docs/vcd_vm_update-os-section.md create mode 100644 docs/vcd_vm_update-vhs-disk.md create mode 100644 docs/vcd_vm_update-vhs-media.md create mode 100644 docs/vcd_vm_update-vm-capabilities.md diff --git a/docs/commands.md b/docs/commands.md index fc485428..39165774 100644 --- a/docs/commands.md +++ b/docs/commands.md @@ -22,6 +22,10 @@ upload
  • +datastore
    • +
  • disk
  • @@ -407,6 +449,7 @@ add-nic
  • attach-disk
  • check-compliance
  • +check-post-gc-script
  • consolidate
  • copy
  • create-snapshot
  • @@ -417,24 +460,56 @@ detach-disk
  • discard-suspend
  • eject-cd
  • +enable-nested-hypervisor
  • +gc-enable
  • +gc-status
  • general-setting
  • +get-compliance-result
  • info
  • insert-cd
  • install-vmware-tools
  • list
  • +list-boot-options
  • +list-current-metrics
  • +list-gc-section
  • +list-historic-metrics
  • +list-metadata
  • +list-mks-ticket
  • list-nics
  • +list-os-section
  • +list-product-sections
  • +list-runtime-info
  • +list-sample-historic-data
  • +list-screen-ticket
  • list-storage-profile
  • +list-subset-current-metrics
  • +list-virtual-hardware-section
  • +list-vm-capabilities
  • move
  • power-off
  • power-on
  • +poweron-force-recustomize
  • reboot
  • reload-from-vc
  • +relocate
  • +remove-metadata
  • +remove-snapshot
  • reset
  • revert-to-snapshot
  • +set-metadata
  • shutdown
  • suspend
  • undeploy
  • update
  • +update-boot-options
  • +update-gc-section
  • +update-general-setting
  • +update-metadata
  • +update-nic
  • +update-os-section
  • +update-vhs-disk
  • +update-vhs-media
  • +update-vm-capabilities
  • upgrade-virtual-hardware
    • diff --git a/docs/vcd.md b/docs/vcd.md index b42b42e1..d71eba91 100644 --- a/docs/vcd.md +++ b/docs/vcd.md @@ -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 ``` diff --git a/docs/vcd_catalog_acl_share.md b/docs/vcd_catalog_acl_share.md index 91388a15..fbfdb772 100644 --- a/docs/vcd_catalog_acl_share.md +++ b/docs/vcd_catalog_acl_share.md @@ -4,6 +4,7 @@ Usage: vcd catalog acl share [OPTIONS] Options: --access-level access level at which the catalog is shared. ReadOnly by default + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_datastore.md b/docs/vcd_datastore.md new file mode 100644 index 00000000..f24c3f89 --- /dev/null +++ b/docs/vcd_datastore.md @@ -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 + +``` diff --git a/docs/vcd_datastore_list.md b/docs/vcd_datastore_list.md new file mode 100644 index 00000000..15c6d9c5 --- /dev/null +++ b/docs/vcd_datastore_list.md @@ -0,0 +1,7 @@ +``` +Usage: vcd datastore list [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_disk_create.md b/docs/vcd_disk_create.md index aa50e37e..41b7ffda 100644 --- a/docs/vcd_disk_create.md +++ b/docs/vcd_disk_create.md @@ -6,6 +6,7 @@ Options: Description of the new disk -s, --storage-profile Name of the Storage Profile to be used for the new disk. + -i, --iops Iops requirements of the new disk -h, --help Show this message and exit. diff --git a/docs/vcd_disk_update.md b/docs/vcd_disk_update.md index ec3f66bf..6e76caf8 100644 --- a/docs/vcd_disk_update.md +++ b/docs/vcd_disk_update.md @@ -8,6 +8,7 @@ Options: New Description of the disk -S, --storage-profile Name of the new Storage Profile to be used for the disk. + -i, --iops New iops requirement of the disk -h, --help Show this message and exit. diff --git a/docs/vcd_gateway_configure-default-gateway_update.md b/docs/vcd_gateway_configure-default-gateway_update.md index e09c41e8..7987f888 100644 --- a/docs/vcd_gateway_configure-default-gateway_update.md +++ b/docs/vcd_gateway_configure-default-gateway_update.md @@ -5,6 +5,7 @@ Options: -e, --external-network external network connected to the gateway. [required] + -i, --gateway-ip IP of the gateway. [required] --enable / --disable enables/disables the default gateway -h, --help Show this message and exit. diff --git a/docs/vcd_gateway_configure-external-network_add.md b/docs/vcd_gateway_configure-external-network_add.md index fee3f8d0..48917c52 100644 --- a/docs/vcd_gateway_configure-external-network_add.md +++ b/docs/vcd_gateway_configure-external-network_add.md @@ -5,6 +5,7 @@ Options: -e, --external-network external network to which the gateway can connect. [required] + --configure-ip-setting configuring multiple IP settings -h, --help Show this message and exit. diff --git a/docs/vcd_gateway_configure-external-network_remove.md b/docs/vcd_gateway_configure-external-network_remove.md index 44585e04..1ab2c87f 100644 --- a/docs/vcd_gateway_configure-external-network_remove.md +++ b/docs/vcd_gateway_configure-external-network_remove.md @@ -5,6 +5,7 @@ Options: -e, --external-network external network that needs to be removed from the gateway. [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_gateway_configure-ip-settings.md b/docs/vcd_gateway_configure-ip-settings.md index dd47e61d..911be584 100644 --- a/docs/vcd_gateway_configure-ip-settings.md +++ b/docs/vcd_gateway_configure-ip-settings.md @@ -5,6 +5,7 @@ Options: -e, --external-network external networks to which the new gateway can connect. [required] + -s, --subnet-available set the subnet settings [required] -h, --help Show this message and exit. diff --git a/docs/vcd_gateway_configure-rate-limits_disable.md b/docs/vcd_gateway_configure-rate-limits_disable.md index 0fa89d51..76098944 100644 --- a/docs/vcd_gateway_configure-rate-limits_disable.md +++ b/docs/vcd_gateway_configure-rate-limits_disable.md @@ -5,6 +5,7 @@ Options: -e, --external-network external network connected to the gateway. [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_gateway_create.md b/docs/vcd_gateway_create.md index d86ce378..f6341b34 100644 --- a/docs/vcd_gateway_create.md +++ b/docs/vcd_gateway_create.md @@ -5,13 +5,16 @@ Options: -e, --external-network list of external networks to which the new gateway can connect. [required] + --description description --default-gateway name of external network for default gateway configuration + --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 @@ -22,19 +25,24 @@ Options: --distributed-routing-enabled / --distributed-routing-disabled enable distributed routing for networks connected to this gateway. + --configure-ip-setting configuring multiple ip settings --sub-allocate-ip sub-allocate the IP Pools provided by the externally connected interfaces + --subnet subnet for the selected external network for IP sub allocation + --ip-range IP ranges pertaining to external network's IP Pool + --configure-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 diff --git a/docs/vcd_gateway_enable-distributed-routing.md b/docs/vcd_gateway_enable-distributed-routing.md index 14d17f88..6eadd683 100644 --- a/docs/vcd_gateway_enable-distributed-routing.md +++ b/docs/vcd_gateway_enable-distributed-routing.md @@ -4,6 +4,7 @@ Usage: vcd gateway enable-distributed-routing [OPTIONS] Options: --enable / --disable Enable distributed routing for networks connected to this gateway. + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_gateway_services_dhcp-pool_create.md b/docs/vcd_gateway_services_dhcp-pool_create.md index 3a15da66..73980155 100644 --- a/docs/vcd_gateway_services_dhcp-pool_create.md +++ b/docs/vcd_gateway_services_dhcp-pool_create.md @@ -6,14 +6,14 @@ Options: IP range of the DHCP pool [required] --enable-auto-dns / --disable-auto-dns Auto configure DNS - -g--gateway-ip + -g, --gateway-ip Default gateway ip - -d--domain domain name - -p--primary-server + -d, --domain domain name + -p, --primary-server primary server ip - -s--secondary-server + -s, --secondary-server secondary server ip - -l--lease lease time + -l, --lease lease time --never-expire-lease / --expire-lease lease lease expire --subnet subnet mask diff --git a/docs/vcd_gateway_services_firewall.md b/docs/vcd_gateway_services_firewall.md index 59abf267..64c02740 100644 --- a/docs/vcd_gateway_services_firewall.md +++ b/docs/vcd_gateway_services_firewall.md @@ -79,6 +79,7 @@ Commands: delete delete firewall rule delete-destination delete firewall rule's destination value of a firewall rule + delete-service delete firewall rule's service of a firewall rule delete-source delete firewall rule's source value of a firewall rule disable disable firewall rule diff --git a/docs/vcd_gateway_services_firewall_list-object-types.md b/docs/vcd_gateway_services_firewall_list-object-types.md index 90882bef..7c7a938a 100644 --- a/docs/vcd_gateway_services_firewall_list-object-types.md +++ b/docs/vcd_gateway_services_firewall_list-object-types.md @@ -5,6 +5,7 @@ Usage: vcd gateway services firewall list-object-types [OPTIONS] type. possible value will be source/destination [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_gateway_services_firewall_list-objects.md b/docs/vcd_gateway_services_firewall_list-objects.md index c8abb648..9eb988aa 100644 --- a/docs/vcd_gateway_services_firewall_list-objects.md +++ b/docs/vcd_gateway_services_firewall_list-objects.md @@ -4,6 +4,7 @@ Usage: vcd gateway services firewall list-objects [OPTIONS] Options: --type type. possible value will be source/destination [required] + --object-type object type [required] -h, --help Show this message and exit. diff --git a/docs/vcd_gateway_services_firewall_update.md b/docs/vcd_gateway_services_firewall_update.md index 43a2db0f..321656f5 100644 --- a/docs/vcd_gateway_services_firewall_update.md +++ b/docs/vcd_gateway_services_firewall_update.md @@ -4,9 +4,11 @@ Usage: vcd gateway services firewall update [OPTIONS] Options: --source it should be in value:value_type format. for ex: Extnw:gatewayinterface + --destination it should be in value:value_type format. for ex: Extnw:gatewayinterface + --service configure services of firewall --name new name of the firewall rule diff --git a/docs/vcd_gateway_services_ipsec-vpn.md b/docs/vcd_gateway_services_ipsec-vpn.md index ddb01434..800f6379 100644 --- a/docs/vcd_gateway_services_ipsec-vpn.md +++ b/docs/vcd_gateway_services_ipsec-vpn.md @@ -69,6 +69,7 @@ Commands: set-log-level set log level of IPsec VPN. It's value should be from the domain:{emergency, alert, critical, error, warning, notice, info, debug) + update update IPsec VPN ``` diff --git a/docs/vcd_gateway_services_ipsec-vpn_create.md b/docs/vcd_gateway_services_ipsec-vpn_create.md index ce78e9f6..e4573490 100644 --- a/docs/vcd_gateway_services_ipsec-vpn_create.md +++ b/docs/vcd_gateway_services_ipsec-vpn_create.md @@ -7,14 +7,18 @@ Options: -pid, --peer-id Peer id of IPsec VPN. [required] -lip, --local-ip Local IP/Local end point of IPsec VPN. [required] + -pip, --peer-ip Peer IP/Peer end point of IPsec VPN. [required] + -lsubnet, --local-subnet Local subnets of IPsec VPN.These should be given comma separated. [required] + -psubnet, --peer-subnet Peer subnets of IPsec VPN.These should be given comma separated. [required] + -psk, --pre-shared-key Pre shared key of IPsec VPN. [required] --description Description of IPsec VPN. diff --git a/docs/vcd_gateway_services_ipsec-vpn_update.md b/docs/vcd_gateway_services_ipsec-vpn_update.md index 6fec92a0..6a483bd9 100644 --- a/docs/vcd_gateway_services_ipsec-vpn_update.md +++ b/docs/vcd_gateway_services_ipsec-vpn_update.md @@ -11,9 +11,11 @@ Options: -lsubnet, --local-subnet Local subnets of IPsec VPN.These should be given comma separated. + -psubnet, --peer-subnet Peer subnets of IPsec VPN.These should be given comma separated. + -psk, --pre-shared-key Pre shared key of IPsec VPN. --description Description of IPsec VPN. diff --git a/docs/vcd_gateway_sub-allocate-ip_add.md b/docs/vcd_gateway_sub-allocate-ip_add.md index b0d28544..4c88d344 100644 --- a/docs/vcd_gateway_sub-allocate-ip_add.md +++ b/docs/vcd_gateway_sub-allocate-ip_add.md @@ -5,8 +5,10 @@ Options: -e, --external-network external network connected to the gateway. [required] + -i, --ip-range ip ranges used for static pool allocation in the network. [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_gateway_sub-allocate-ip_remove.md b/docs/vcd_gateway_sub-allocate-ip_remove.md index 72f6f5af..fec306b7 100644 --- a/docs/vcd_gateway_sub-allocate-ip_remove.md +++ b/docs/vcd_gateway_sub-allocate-ip_remove.md @@ -5,8 +5,10 @@ Options: -e, --external-network external network connected to the gateway. [required] + -i, --ip-range IP ranges that needs to be removed. [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_gateway_sub-allocate-ip_update.md b/docs/vcd_gateway_sub-allocate-ip_update.md index 76867f21..27944013 100644 --- a/docs/vcd_gateway_sub-allocate-ip_update.md +++ b/docs/vcd_gateway_sub-allocate-ip_update.md @@ -5,12 +5,15 @@ Options: -e, --external-network external network connected to the gateway. [required] + -o, --old-ip-range existing IP ranges used for static pool allocation in the network. [required] + -n, --new-ip-range new IP range to replace the existing IP range. [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_login.md b/docs/vcd_login.md index f6f1d815..33c8a16e 100644 --- a/docs/vcd_login.md +++ b/docs/vcd_login.md @@ -32,12 +32,13 @@ Usage: vcd login [OPTIONS] host organization user Options: -p, --password Password - -V, --version [29.0|30.0|31.0|32.0|33.0] + -V, --version [29.0|30.0|31.0|32.0|33.0|34.0|35.0|36.0] API version -s, --verify-ssl-certs / -i, --no-verify-ssl-certs Verify SSL certificates -w, --disable-warnings Do not display warnings when not verifying SSL certificates + -v, --vdc TEXT virtual datacenter -d, --session-id TEXT session id -b, --use-browser-session Use browser session diff --git a/docs/vcd_network_direct_create.md b/docs/vcd_network_direct_create.md index 719de4de..d9d1d630 100644 --- a/docs/vcd_network_direct_create.md +++ b/docs/vcd_network_direct_create.md @@ -5,11 +5,13 @@ Options: -p, --parent Name of the external network to be connected to [required] + -d, --description Description of the network to be created -s, --shared / -n, --not-shared Share/Don't share the network with other VDC(s) in the organization + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_network_external.md b/docs/vcd_network_external.md index 017c91f8..faf1b37e 100644 --- a/docs/vcd_network_external.md +++ b/docs/vcd_network_external.md @@ -107,12 +107,14 @@ Options: Commands: add-ip-range add an IP range to a subnet in an external network + add-subnet add subnet to an external network attach-port-group attach a port group to an external network create create a new external network delete delete an external network delete-ip-range delete an IP range of a subnet in an external network + detach-port-group detach port group from an external network enable-subnet enable subnet of an external network info show external network details @@ -125,6 +127,7 @@ Commands: list-vsphere-network list associated vSphere networks update update name and description of an external network + update-ip-range update an IP range of a subnet in an external network diff --git a/docs/vcd_network_external_add-subnet.md b/docs/vcd_network_external_add-subnet.md index 7247b005..fbfa0268 100644 --- a/docs/vcd_network_external_add-subnet.md +++ b/docs/vcd_network_external_add-subnet.md @@ -6,6 +6,7 @@ Options: -n, --netmask network mask of the subnet [required] -i, --ip-range ip range in StartAddress-EndAddress format [required] + --dns1 ip of the primary dns server of the subnet --dns2 ip of the secondary dns server of the subnet --dns-suffix dns suffix diff --git a/docs/vcd_network_external_create.md b/docs/vcd_network_external_create.md index d44e6caf..3f9dd0c5 100644 --- a/docs/vcd_network_external_create.md +++ b/docs/vcd_network_external_create.md @@ -5,13 +5,16 @@ Options: -v, --vc name of the vCenter [required] -p, --port-group portgroup to create external network [required] + -g, --gateway gateway of the subnet [required] -n, --netmask network mask of the subnet [required] -i, --ip-range IP range in StartAddress-EndAddress format [required] + -d, --description Description of the external network to be created + --dns1 IP of the primary DNS server of the subnet --dns2 IP of the secondary DNS server of the subnet --dns-suffix DNS suffix diff --git a/docs/vcd_network_external_update-ip-range.md b/docs/vcd_network_external_update-ip-range.md index 234f89e9..1aa49332 100644 --- a/docs/vcd_network_external_update-ip-range.md +++ b/docs/vcd_network_external_update-ip-range.md @@ -5,8 +5,10 @@ Options: -g, --gateway gateway ip of the subnet [required] -i, --ip-range ip range in StartAddress-EndAddress format [required] + -n, --new-ip-range ip range in StartAddress-EndAddress format [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_network_isolated_create.md b/docs/vcd_network_isolated_create.md index ed67b8ae..f1d65760 100644 --- a/docs/vcd_network_isolated_create.md +++ b/docs/vcd_network_isolated_create.md @@ -4,6 +4,7 @@ Usage: vcd network isolated create [OPTIONS] Options: -g, --gateway IP address of the gateway of the new network [required] + -n, --netmask network mask for the gateway [required] -d, --description Description of the network to be created @@ -12,19 +13,25 @@ Options: --dns-suffix DNS suffix --ip-range-start Start address of the IP ranges used for static pool allocation in the network + --ip-range-end End address of the IP ranges used for static pool allocation in the network + --dhcp-enabled / --dhcp-disabled Enable/Disable DHCP service on the new network + --default-lease-time Default lease in seconds for DHCP addresses --max-lease-time Max lease in seconds for DHCP addresses --dhcp-ip-range-start Start address of the IP range used for DHCP addresses + --dhcp-ip-range-end End address of the IP range used for DHCP addresses + --shared / --not-shared Share/Don't share the network with other VDC(s) in the organization + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_network_routed.md b/docs/vcd_network_routed.md index 5cd90fda..3a85ff6c 100644 --- a/docs/vcd_network_routed.md +++ b/docs/vcd_network_routed.md @@ -92,15 +92,18 @@ Commands: delete delete org vdc routed network delete-ip-range delete an IP range from a routed org vdc network + edit Edit a routed org vdc network info show routed network information list list all routed org vdc networks in the selected vdc + list-allocated-ip list allocated IP addresses list-connected-vapps list connected vApps list-metadata list metadata of a routed org vdc network remove-metadata remove metadata from a routed org vdc network + set-metadata set metadata to a routed org vdc network update-ip-range Update IP range of routed org vdc network. diff --git a/docs/vcd_network_routed_create.md b/docs/vcd_network_routed_create.md index e32cfb04..f40b6c25 100644 --- a/docs/vcd_network_routed_create.md +++ b/docs/vcd_network_routed_create.md @@ -4,6 +4,7 @@ Usage: vcd network routed create [OPTIONS] Options: -g, --gateway-name name of gateway to which this network will connect [required] + --subnet Network CIDR [required] --description description diff --git a/docs/vcd_network_routed_edit.md b/docs/vcd_network_routed_edit.md index 771f025d..78b72322 100644 --- a/docs/vcd_network_routed_edit.md +++ b/docs/vcd_network_routed_edit.md @@ -7,6 +7,7 @@ Options: --shared-enabled / --shared-disabled share this network with other VDCs in the organization + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_network_routed_update-ip-range.md b/docs/vcd_network_routed_update-ip-range.md index 81151eae..aaaab825 100644 --- a/docs/vcd_network_routed_update-ip-range.md +++ b/docs/vcd_network_routed_update-ip-range.md @@ -4,8 +4,10 @@ Usage: vcd network routed update-ip-range [OPTIONS] Options: -i, --ip-range ip range in StartAddress-EndAddress format [required] + -n, --new-ip-range ip range in StartAddress-EndAddress format [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_nsxt_register.md b/docs/vcd_nsxt_register.md index 7c2fb7d1..66c9f8e3 100644 --- a/docs/vcd_nsxt_register.md +++ b/docs/vcd_nsxt_register.md @@ -4,6 +4,7 @@ Usage: vcd nsxt register [OPTIONS] Options: -U, --url [url] https:// of NSX-T host [required] + -u, --user [username] NSX-T admin user name [required] -p, --password [password] NSX-T admin password [required] -d, --desc [description] description of NSX-T manager diff --git a/docs/vcd_org_delete.md b/docs/vcd_org_delete.md index 38683f34..dfd3a9b6 100644 --- a/docs/vcd_org_delete.md +++ b/docs/vcd_org_delete.md @@ -4,8 +4,10 @@ Usage: vcd org delete [OPTIONS] Options: -r, --recursive removes the Org and any objects it contains that are in a state that normally allows removal + -f, --force pass this option along with --recursive to remove an Org and any objects it contains, regardless of their state + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_pvdc_create.md b/docs/vcd_pvdc_create.md index 769dc68b..0fb3f896 100644 --- a/docs/vcd_pvdc_create.md +++ b/docs/vcd_pvdc_create.md @@ -4,20 +4,25 @@ Usage: vcd pvdc create [OPTIONS] Options: -s, --storage-profile TEXT storage profile name (required parameter, can have multiple) [required] + -r, --resource-pool TEXT resource pool name (required parameter, can have multiple) [required] + -n, --vxlan-network-pool [vxlan-network-pool] vxlan network pool name -t, --nsxt-manager-name [nsxt-manager-name] nsx-t manager name (valid for vCD API version 31.0 and above) + -d, --description [description] description of PVDC -e, --enable enable flag (enables PVDC when it is created) + -v, --highest-supp-hw-vers [highest-supp-hw-vers] highest supported hw version, e.g. vmx-11, vmx-10, vmx-09, etc. + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_role.md b/docs/vcd_role.md index 0ec0b213..fce64c61 100644 --- a/docs/vcd_role.md +++ b/docs/vcd_role.md @@ -37,15 +37,22 @@ Usage: vcd role [OPTIONS] COMMAND [ARGS]... vcd role remove-right myRole myRight1 myRight2 -o myOrg Removes one or more rights from a given role. - + vcd role clone "Organization Adminstrator" cloned_role + Creates a new role 'cloned_role' with the same rights and + description as "Organization Administrator" + Options: -h, --help Show this message and exit. Commands: add-right Adds one or more rights to the role + clone Creates a role that is a copy of an existing role in the + specified org(defaults to the current org in use) + create Creates role in the specified Organization (defaults to the current Organization in use) + delete Deletes role in the specified Organization info show details of a role link Link the role of a given org to its template diff --git a/docs/vcd_role_clone.md b/docs/vcd_role_clone.md new file mode 100644 index 00000000..b1d93476 --- /dev/null +++ b/docs/vcd_role_clone.md @@ -0,0 +1,12 @@ +``` +Usage: vcd role clone [OPTIONS] + +Options: + -o, --org [org-name] Name of the org + -d, --description [description] + Role description (Defaults to description of + role being cloned) + + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_user_create.md b/docs/vcd_user_create.md index 88b3ed39..4bb7057f 100644 --- a/docs/vcd_user_create.md +++ b/docs/vcd_user_create.md @@ -14,8 +14,10 @@ Options: --alert-email-prefix [alert_email_prefix] String to prepend to the alert message subject line + --external Indicates if user is imported from an external source + --default-cached Indicates if user should be cached -g, --group-role Indicates if the user has a group role -s, --stored-vm-quota [stored_vm_quota] @@ -23,6 +25,7 @@ Options: -d, --deployed-vm-quota [deployed_vm_quota] Quota of vApps that this user can deploy concurrently + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_vapp.md b/docs/vcd_vapp.md index ecc0df47..6e006288 100644 --- a/docs/vcd_vapp.md +++ b/docs/vcd_vapp.md @@ -172,6 +172,38 @@ Usage: vcd vapp [OPTIONS] COMMAND [ARGS]... vcd vapp remove-snapshot vapp1 Remove snapshot of the vapp. + + vcd vapp enable-download vapp1 + Enable download of the vapp. + + vcd vapp disable-download vapp1 + Disable download of the vapp. + + vcd vapp show-lease vapp1 + Show vApp lease details. + + vcd vapp show-metadata vapp1 + Show metadata of vapp. + + vcd vapp update-startup-section vapp1 testvm1 --o 1 --start-action + powerOn --start-delay 4 --stop-action guestShutdown --stop-delay 3 + Update startup section of vapp + + vcd vapp show-startup-section vapp1 + Show startup section data of vapp. + + vcd vapp show-product-section vapp1 + Show product section data of vapp. + + vcd vapp update-product-section vapp1 --key testkey --value testvalue + --class_name testclassname --instance_name testinstancename --label + labledata --is_password true --user_configurable false + Update product section of vapp. + + vcd vapp add-vm-scratch vapp1 -vm vm1 -cn computer_name -d description + -os windows7_64Guest -cpu 2 -cps 2 -crm 2 -m 1024 -media + pb1.iso -aae -deploy -power-on + Add a VM from scratch to a vApp. Options: @@ -181,6 +213,7 @@ Commands: acl work with vapp acl add-disk add disk to vm add-vm add VM to vApp + add-vm-scratch add VM from scratch to vApp attach attach disk to VM in vApp capture Capture a vApp as template change-owner change vApp owner @@ -191,9 +224,11 @@ Commands: delete delete a vApp or VM(s) deploy Deploy a vApp or VM(s) detach detach disk from VM in vApp + disable-download disbale a vapp for download discard-suspended-state discard suspended state of vApp disconnect disconnect an ovdc network from a vapp download Download a vApp + enable-download enable a vapp for download enter-maintenance-mode Place a vApp in Maintenance Mode exit-maintenance-mode exit maintenance mode a vApp info show vApp details @@ -206,12 +241,18 @@ Commands: remove-snapshot rmove snapshot of vapp reset Reset a vApp or VM(s) revert-to-snapshot revert vapp to current snapshot + show-lease show a vapp lease details + show-metadata show metadata of vapp + show-product-section show product sections of vapp + show-startup-section show startup section of vapp shutdown shutdown a vApp stop stop a vApp suspend suspend a vApp undeploy undeploy a vApp or VM(s) update update vapp's name and description update-lease update vApp lease + update-product-section update product section of vapp + update-startup-section update startup section of vapp for vm upgrade-virtual-hardware upgrade virtual hardware of a vApp use set active vApp diff --git a/docs/vcd_vapp_acl_share.md b/docs/vcd_vapp_acl_share.md index 56d11dc1..c5ba6162 100644 --- a/docs/vcd_vapp_acl_share.md +++ b/docs/vcd_vapp_acl_share.md @@ -4,6 +4,7 @@ Usage: vcd vapp acl share [OPTIONS] Options: --access-level access level at which the vapp is shared. ReadOnly by default + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_vapp_add-vm-scratch.md b/docs/vcd_vapp_add-vm-scratch.md new file mode 100644 index 00000000..006c4d94 --- /dev/null +++ b/docs/vcd_vapp_add-vm-scratch.md @@ -0,0 +1,25 @@ +``` +Usage: vcd vapp add-vm-scratch [OPTIONS] + +Options: + -vm, --vm_name name of vm [required] + -cn, --computer_name + computer name of vm [required] + -d, --description + description of vm + -os, --os_type os name of vm [required] + -cpu, --virtual_cpu + no of virtual cpu + -cps, --core_per_socket + core per socket + -crm, --cpu_resource_mhz + cpu resource in Mhz + -m, --memory memory in MB + -media, --media_name + media name of boot image + -aae, --accept-all-eulas Accept all EULAs + -deploy, --deploy deploy vm + -power-on, --power_on power on vm + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_add-vm.md b/docs/vcd_vapp_add-vm.md index efeca84a..fc12a0a1 100644 --- a/docs/vcd_vapp_add-vm.md +++ b/docs/vcd_vapp_add-vm.md @@ -4,6 +4,7 @@ Usage: vcd vapp add-vm [OPTIONS] Options: -c, --catalog name Name of the catalog if the source vApp is a template + -t, --target-vm name Rename the target VM with this name -o, --hostname hostname Customize VM and set hostname in the guest OS -n, --network name vApp network to connect to diff --git a/docs/vcd_vapp_connect.md b/docs/vcd_vapp_connect.md index 5b0dd5d7..c66b2998 100644 --- a/docs/vcd_vapp_connect.md +++ b/docs/vcd_vapp_connect.md @@ -4,8 +4,10 @@ Usage: vcd vapp connect [OPTIONS] Options: --retain-ip True if the network resources such as IP/MAC of router will be retained across deployments. False by default + --is-deployed True if this orgvdc network has been deployed. False by default + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_vapp_copy.md b/docs/vcd_vapp_copy.md index 45ee8dc7..67a64584 100644 --- a/docs/vcd_vapp_copy.md +++ b/docs/vcd_vapp_copy.md @@ -5,6 +5,7 @@ Options: -n, --name name of copy vapp [required] -v, --vdc virtual datacenter name where need to copy vapp + -d, --description description of copy vapp -h, --help Show this message and exit. diff --git a/docs/vcd_vapp_deploy.md b/docs/vcd_vapp_deploy.md index 6904548b..8101a394 100644 --- a/docs/vcd_vapp_deploy.md +++ b/docs/vcd_vapp_deploy.md @@ -4,8 +4,10 @@ Usage: vcd vapp deploy [OPTIONS] NAME [VM_NAMES]... Options: --power-on / --power-off Specifies whether to power on/off vApp/VM on deployment,if not specified, default is power on + --force-customization Specifies whether to force customization on deployment,if not specified, default is False + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_vapp_disable-download.md b/docs/vcd_vapp_disable-download.md new file mode 100644 index 00000000..564c6f2d --- /dev/null +++ b/docs/vcd_vapp_disable-download.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp disable-download [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_enable-download.md b/docs/vcd_vapp_enable-download.md new file mode 100644 index 00000000..8a5c8326 --- /dev/null +++ b/docs/vcd_vapp_enable-download.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp enable-download [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network.md b/docs/vcd_vapp_network.md index eb71eafc..46c0506a 100644 --- a/docs/vcd_vapp_network.md +++ b/docs/vcd_vapp_network.md @@ -62,6 +62,15 @@ Usage: vcd vapp network [OPTIONS] COMMAND [ARGS]... vcd vapp network sync-syslog-settings vapp1 vapp-network1 Sync syslog settings of vapp network + + vdc vapp network create-ovdc-network vapp1 ovdc-network1 + Create a vApp network using org vdc network. + + vdc vapp network enable-fence vapp1 + Enable fence mode of vApp network. + + vdc vapp network list-vm-interface vapp1 vapp-network1 + List vm interfaces of network. Options: @@ -72,11 +81,14 @@ Commands: add-ip-range add IP range/s to the network connect-ovdc connect a vapp network to org vdc network create create a vApp network + create-ovdc-network create a vapp network using org vdc network delete delete a vApp network delete-ip-range delete an IP range in network dns-info show DNS details of vapp network + enable-fence enable fence mode of vapp network list list vapp networks list-allocated-ip list allocated IP + list-vm-interface list vm interfaces of network reset reset a vApp network services manage vapp network services sync-syslog-settings sync syslog settings of vapp network diff --git a/docs/vcd_vapp_network_create-ovdc-network.md b/docs/vcd_vapp_network_create-ovdc-network.md new file mode 100644 index 00000000..e8978406 --- /dev/null +++ b/docs/vcd_vapp_network_create-ovdc-network.md @@ -0,0 +1,8 @@ +``` +Usage: vcd vapp network create-ovdc-network [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_enable-fence.md b/docs/vcd_vapp_network_enable-fence.md new file mode 100644 index 00000000..964c3960 --- /dev/null +++ b/docs/vcd_vapp_network_enable-fence.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp network enable-fence [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_list-vm-interface.md b/docs/vcd_vapp_network_list-vm-interface.md new file mode 100644 index 00000000..5f940100 --- /dev/null +++ b/docs/vcd_vapp_network_list-vm-interface.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp network list-vm-interface [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services.md b/docs/vcd_vapp_network_services.md index 8ffc0a29..e0c7d609 100644 --- a/docs/vcd_vapp_network_services.md +++ b/docs/vcd_vapp_network_services.md @@ -7,7 +7,9 @@ Options: -h, --help Show this message and exit. Commands: - dhcp manage DHCP service of vapp network - firewall manage firewall service of vapp network + dhcp manage DHCP service of vapp network + firewall manage firewall service of vapp network + nat manage NAT service of vapp network + static-route manage static route service of vapp network ``` diff --git a/docs/vcd_vapp_network_services_dhcp_set.md b/docs/vcd_vapp_network_services_dhcp_set.md index a500b455..ab380bed 100644 --- a/docs/vcd_vapp_network_services_dhcp_set.md +++ b/docs/vcd_vapp_network_services_dhcp_set.md @@ -4,6 +4,7 @@ Usage: vcd vapp network services dhcp set [OPTIONS] Options: -i, --ip-range IP range in StartAddress-EndAddress format [required] + -dlt, --default-lease-time default lease time -mlt, --max-lease-time max lease time diff --git a/docs/vcd_vapp_network_services_firewall.md b/docs/vcd_vapp_network_services_firewall.md index 1e9d6b86..851cb226 100644 --- a/docs/vcd_vapp_network_services_firewall.md +++ b/docs/vcd_vapp_network_services_firewall.md @@ -8,10 +8,39 @@ Usage: vcd vapp network services firewall [OPTIONS] COMMAND [ARGS]... network_name --enable Enable firewall service. + vcd vapp network services firewall set-default-action vapp_name + network_name --action allow --log-action False + Set deault action in firewall service. + + vcd vapp network services firewall list vapp_name network_name + List firewall rules in firewall service. + + vcd vapp network services firewall add vapp_name network_name rule_name + --enable --policy drop --protocols Tcp,Udp --source-ip Any + --source-port-range Any --destination-port-range Any + --destination-ip Any --enable-logging + Add firewall rule in firewall service. + + vcd vapp network services firewall update vapp_name network_name + rule_name --name rule_new_name --enable --policy + drop --protocols Tcp,Udp --source-ip Any + --source-port-range Any --destination-port-range Any + --destination-ip Any --enable-logging + Update firewall rule in firewall service. + + vcd vapp network services firewall delete vapp_name network_name + --name firewall_rule_name + Delete firewall rule in firewall service. + Options: -h, --help Show this message and exit. Commands: - enable-firewall Enable firewall service + add add firewall rule to firewall service + delete delete firewall rule in firewall service + enable-firewall Enable firewall service + list list firewall rules in firewall service + set-default-action set default action of firewall service + update update firewall rule of firewall service ``` diff --git a/docs/vcd_vapp_network_services_firewall_add.md b/docs/vcd_vapp_network_services_firewall_add.md new file mode 100644 index 00000000..7869fa09 --- /dev/null +++ b/docs/vcd_vapp_network_services_firewall_add.md @@ -0,0 +1,20 @@ +``` +Usage: vcd vapp network services firewall add [OPTIONS] + +Options: + --enable / --disable enable firewall rule + --policy policy on firewall rule + --protocols all protocol names in comma separated format + --source-port-range + source port range on firewall rule + --source-ip source ip on firewall rule + --destination-port-range + destination port range on firewall rule + --destination-ip + destination ip on firewall rule + --enable-logging / --disable-logging + enable logging on firewall rule + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_firewall_delete.md b/docs/vcd_vapp_network_services_firewall_delete.md new file mode 100644 index 00000000..17329282 --- /dev/null +++ b/docs/vcd_vapp_network_services_firewall_delete.md @@ -0,0 +1,9 @@ +``` +Usage: vcd vapp network services firewall delete [OPTIONS] + + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_firewall_enable-firewall.md b/docs/vcd_vapp_network_services_firewall_enable-firewall.md index 737a5f3a..385dc941 100644 --- a/docs/vcd_vapp_network_services_firewall_enable-firewall.md +++ b/docs/vcd_vapp_network_services_firewall_enable-firewall.md @@ -3,7 +3,7 @@ Usage: vcd vapp network services firewall enable-firewall [OPTIONS] Options: - --enable / --disable + --enable / --disable enable firewall service -h, --help Show this message and exit. ``` diff --git a/docs/vcd_vapp_network_services_firewall_list.md b/docs/vcd_vapp_network_services_firewall_list.md new file mode 100644 index 00000000..e9e4e439 --- /dev/null +++ b/docs/vcd_vapp_network_services_firewall_list.md @@ -0,0 +1,8 @@ +``` +Usage: vcd vapp network services firewall list [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_firewall_set-default-action.md b/docs/vcd_vapp_network_services_firewall_set-default-action.md new file mode 100644 index 00000000..5299e3d3 --- /dev/null +++ b/docs/vcd_vapp_network_services_firewall_set-default-action.md @@ -0,0 +1,11 @@ +``` +Usage: vcd vapp network services firewall set-default-action + [OPTIONS] + +Options: + --action deafult action on firewall service + --enable-log-action / --disable-log-action + default action on firewall service log + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_firewall_update.md b/docs/vcd_vapp_network_services_firewall_update.md new file mode 100644 index 00000000..445fa658 --- /dev/null +++ b/docs/vcd_vapp_network_services_firewall_update.md @@ -0,0 +1,22 @@ +``` +Usage: vcd vapp network services firewall update [OPTIONS] + + +Options: + --name new name of firewall rule + --enable / --disable enable firewall rule + --policy policy on firewall rule + --protocols all protocol names in comma separated format + --source-port-range + source port range on firewall rule + --source-ip source ip on firewall rule + --destination-port-range + destination port range on firewall rule + --destination-ip + destination ip on firewall rule + --enable-logging / --disable-logging + enable logging on firewall rule + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_nat.md b/docs/vcd_vapp_network_services_nat.md new file mode 100644 index 00000000..71026257 --- /dev/null +++ b/docs/vcd_vapp_network_services_nat.md @@ -0,0 +1,64 @@ +``` +Usage: vcd vapp network services nat [OPTIONS] COMMAND [ARGS]... + + Manages NAT service of vapp network. + + Examples + vcd vapp network services nat enable-nat vapp_name network_name + --enable + Enable NAT service. + + vcd vapp network services nat set-nat-type vapp_name network_name + --type ipTranslation --policy allowTrafficIn + Set NAT type in NAT service. + + vcd vapp network services nat get-nat-type vapp_name network_name + Get NAT type and policy in NAT service. + + vcd vapp network services nat add vapp_name network_name + --type ipTranslation --vm_id testvm1 --nic_id 1 + Add NAT rule to NAT service. + + vcd vapp network services nat add vapp_name network_name + --type ipTranslation --vm_id testvm1 --nic_id 1 --mapping_mode + manual --ext_ip 10.1.1.1 + Add NAT rule to NAT service. + + vcd vapp network services nat add vapp_name network_name + --type portForwarding --vm_id testvm1 --nic_id 1 --ext_port -1 + --int_port -1 --protocol TCP_UDP + Add NAT rule to NAT service. + + vcd vapp network services nat list vapp_name network_name + List NAT rules in NAT service. + + vcd vapp network services nat delete vapp_name network_name id + Delete NAT rule from NAT service. + + vcd vapp network services nat update vapp_name network_name rule_id + --vm_id testvm1 --nic_id 1 + Update NAT rule to NAT service. + + vcd vapp network services nat update vapp_name network_name rule_id + --vm_id testvm1 --nic_id 1 --mapping_mode manual + --ext_ip 10.1.1.1 + Update NAT rule to NAT service. + + vcd vapp network services nat update vapp_name network_name rule_id + --vm_id testvm1 --nic_id 1 --ext_port -1 --int_port -1 + --protocol TCP_UDP + Update NAT rule to NAT service. + +Options: + -h, --help Show this message and exit. + +Commands: + add add NAT rule + delete delete NAT rules + enable-nat enable NAT service + get-nat-type get NAT type + list list NAT rules + set-nat-type set NAT type + update update NAT rule + +``` diff --git a/docs/vcd_vapp_network_services_nat_add.md b/docs/vcd_vapp_network_services_nat_add.md new file mode 100644 index 00000000..16ac6a72 --- /dev/null +++ b/docs/vcd_vapp_network_services_nat_add.md @@ -0,0 +1,15 @@ +``` +Usage: vcd vapp network services nat add [OPTIONS] + +Options: + --type type of NAT service [required] + --vm_id VM local id [required] + --nic_id NIC id of vapp network in vm [required] + --mapping_mode mapping mode of NAT rule + --ext_ip external IP address + --ext_port external port + --int_port internal port + --protocol protocol + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_nat_delete.md b/docs/vcd_vapp_network_services_nat_delete.md new file mode 100644 index 00000000..7285ccda --- /dev/null +++ b/docs/vcd_vapp_network_services_nat_delete.md @@ -0,0 +1,8 @@ +``` +Usage: vcd vapp network services nat delete [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_nat_enable-nat.md b/docs/vcd_vapp_network_services_nat_enable-nat.md new file mode 100644 index 00000000..286cb023 --- /dev/null +++ b/docs/vcd_vapp_network_services_nat_enable-nat.md @@ -0,0 +1,9 @@ +``` +Usage: vcd vapp network services nat enable-nat [OPTIONS] + + +Options: + --enable / --disable enable NAT service + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_nat_get-nat-type.md b/docs/vcd_vapp_network_services_nat_get-nat-type.md new file mode 100644 index 00000000..83c35753 --- /dev/null +++ b/docs/vcd_vapp_network_services_nat_get-nat-type.md @@ -0,0 +1,8 @@ +``` +Usage: vcd vapp network services nat get-nat-type [OPTIONS] + + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_nat_list.md b/docs/vcd_vapp_network_services_nat_list.md new file mode 100644 index 00000000..bcbd2732 --- /dev/null +++ b/docs/vcd_vapp_network_services_nat_list.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp network services nat list [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_nat_set-nat-type.md b/docs/vcd_vapp_network_services_nat_set-nat-type.md new file mode 100644 index 00000000..c1412cfd --- /dev/null +++ b/docs/vcd_vapp_network_services_nat_set-nat-type.md @@ -0,0 +1,10 @@ +``` +Usage: vcd vapp network services nat set-nat-type [OPTIONS] + + +Options: + --type type of NAT service + --policy policy of NAT service + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_nat_update.md b/docs/vcd_vapp_network_services_nat_update.md new file mode 100644 index 00000000..906824b8 --- /dev/null +++ b/docs/vcd_vapp_network_services_nat_update.md @@ -0,0 +1,15 @@ +``` +Usage: vcd vapp network services nat update [OPTIONS] + +Options: + --vm_id VM local id + --nic_id NIC id of vapp network in vm + --mapping_mode mapping mode of NAT rule + --ext_ip external IP address + --ext_port external port + --int_port internal port + --protocol protocol + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_static-route.md b/docs/vcd_vapp_network_services_static-route.md new file mode 100644 index 00000000..e500b4c9 --- /dev/null +++ b/docs/vcd_vapp_network_services_static-route.md @@ -0,0 +1,44 @@ +``` +Usage: vcd vapp network services static-route [OPTIONS] COMMAND [ARGS]... + + Manage static route service of vapp network. + + vcd vapp network services static-route enable-service vapp_name + network_name --enable + Enable static route service. + + vcd vapp network services static-route enable-service vapp_name + network_name --disable + Disable static route service. + + vcd vapp network services static-route add vapp_name network_name + --name route_name + --nhip next_hop_ip + --network network_cidr + Add static route in static route service. + + vcd vapp network services static-route list vapp_name network_name + List static route in static route service. + + vcd vapp network services static-route update vapp_name network_name + route_name + --name new_route_name + --network network_cidr + --nhip next_hop_ip + Update static route in static route service. + + vcd vapp network services static-route delete vapp_name network_name + route_name + Delete static route in static route service. + +Options: + -h, --help Show this message and exit. + +Commands: + add add static route in static route service + delete delete static route in static route service + enable-service enable static route service + list list static route in static route service + update update static route in static route service + +``` diff --git a/docs/vcd_vapp_network_services_static-route_add.md b/docs/vcd_vapp_network_services_static-route_add.md new file mode 100644 index 00000000..f36485d0 --- /dev/null +++ b/docs/vcd_vapp_network_services_static-route_add.md @@ -0,0 +1,11 @@ +``` +Usage: vcd vapp network services static-route add [OPTIONS] + + +Options: + --name route name [required] + --network network CIDR [required] + --nhip next hop IP [required] + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_static-route_delete.md b/docs/vcd_vapp_network_services_static-route_delete.md new file mode 100644 index 00000000..522e2986 --- /dev/null +++ b/docs/vcd_vapp_network_services_static-route_delete.md @@ -0,0 +1,9 @@ +``` +Usage: vcd vapp network services static-route delete [OPTIONS] + + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_static-route_enable-service.md b/docs/vcd_vapp_network_services_static-route_enable-service.md new file mode 100644 index 00000000..6e473bb7 --- /dev/null +++ b/docs/vcd_vapp_network_services_static-route_enable-service.md @@ -0,0 +1,9 @@ +``` +Usage: vcd vapp network services static-route enable-service + [OPTIONS] + +Options: + --enable / --disable enable static route service + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_static-route_list.md b/docs/vcd_vapp_network_services_static-route_list.md new file mode 100644 index 00000000..c5aa0977 --- /dev/null +++ b/docs/vcd_vapp_network_services_static-route_list.md @@ -0,0 +1,8 @@ +``` +Usage: vcd vapp network services static-route list [OPTIONS] + + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_services_static-route_update.md b/docs/vcd_vapp_network_services_static-route_update.md new file mode 100644 index 00000000..46749859 --- /dev/null +++ b/docs/vcd_vapp_network_services_static-route_update.md @@ -0,0 +1,12 @@ +``` +Usage: vcd vapp network services static-route update [OPTIONS] + + +Options: + --name route new name + --network network CIDR + --nhip next hop IP + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_network_update-ip-range.md b/docs/vcd_vapp_network_update-ip-range.md index d040641c..412ad3c0 100644 --- a/docs/vcd_vapp_network_update-ip-range.md +++ b/docs/vcd_vapp_network_update-ip-range.md @@ -4,8 +4,10 @@ Usage: vcd vapp network update-ip-range [OPTIONS] Options: -i, --ip-range IP range in StartAddress-EndAddress format [required] + -n, --new-ip-range new IP range in StartAddress-EndAddress format [required] + -h, --help Show this message and exit. ``` diff --git a/docs/vcd_vapp_show-lease.md b/docs/vcd_vapp_show-lease.md new file mode 100644 index 00000000..6517284d --- /dev/null +++ b/docs/vcd_vapp_show-lease.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp show-lease [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_show-metadata.md b/docs/vcd_vapp_show-metadata.md new file mode 100644 index 00000000..0156adc4 --- /dev/null +++ b/docs/vcd_vapp_show-metadata.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp show-metadata [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_show-product-section.md b/docs/vcd_vapp_show-product-section.md new file mode 100644 index 00000000..2c30de32 --- /dev/null +++ b/docs/vcd_vapp_show-product-section.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp show-product-section [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_show-startup-section.md b/docs/vcd_vapp_show-startup-section.md new file mode 100644 index 00000000..6b1b7498 --- /dev/null +++ b/docs/vcd_vapp_show-startup-section.md @@ -0,0 +1,7 @@ +``` +Usage: vcd vapp show-startup-section [OPTIONS] + +Options: + -h, --help Show this message and exit. + +``` diff --git a/docs/vcd_vapp_update-product-section.md b/docs/vcd_vapp_update-product-section.md new file mode 100644 index 00000000..174f9a0b --- /dev/null +++ b/docs/vcd_vapp_update-product-section.md @@ -0,0 +1,23 @@ +``` +Usage: vcd vapp update-product-section [OPTIONS] + +Options: + --key key for property of product section + [required] + + --value value for property of product section + --type type for property value of product section + --class_name class name of product section + --instance_name + instance name of product section + --label