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

appalling documentation divergence #269

Open
MichalTaratuta opened this issue Nov 23, 2018 · 0 comments
Open

appalling documentation divergence #269

MichalTaratuta opened this issue Nov 23, 2018 · 0 comments

Comments

@MichalTaratuta
Copy link

The whole VCD and pyvcloud project is riddled with this type of issue. It's really appalling where documentation says one thing and in the code you find that it's actually something else. Like default values for interfaces or unit sizes.

I really appreciate your hard work but please update documentation the same time as you are updating the code. IT just makes everyone life easier.

vcd-cli, VMware vCloud Director Command Line Interface, 21.0.0

There is no option:
--gateway-ip => --gateway
--primary-dns-ip => --dns1

This is your usage example for vcd network isolated -h:

vcd network isolated -h
Usage: vcd network isolated [OPTIONS] COMMAND [ARGS]...

  Work with isolated org vdc networks.

      Note
          Both System Administrators and Organization Administrators can create,
          delete or list isolated org vdc networks.
  
      Examples
          vcd network isolated create isolated-net1 --gateway-ip 192.168.1.1 \
                  --netmask 255.255.255.0 --description 'Isolated VDC network' \
                  --primary-dns-ip 8.8.8.8 --dns-suffix example.com \
                  --ip-range-start 192.168.1.100 --ip-range-end 192.168.1.199 \
                  --dhcp-enabled --default-lease-time 3600 \
                  --max-lease-time 7200 --dhcp-ip-range-start 192.168.1.100 \
                  --dhcp-ip-range-end 192.168.1.199
              Create an isolated org vdc network with an inbuilt dhcp service.
  
          vcd network isolated list
              List all isolated org vdc networks in the selected vdc
  
          vcd network isolated delete isolated-net1
              Delete isolated network 'isoalted-net1' in the selected vdc
      

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

Commands:
  create  create a new isolated org vdc network in vcd
  delete  delete an isolated org vdc network in the selected vdc
  list    list all isolated org vdc networks in the selected vdc

Those are you expected options for vcd network isolated create -h:

Usage: vcd network isolated create [OPTIONS] <name>

Options:
  -g, --gateway <ip>              IP address of the gateway of the new network
                                  [required]
  -n, --netmask <netmask>         network mask for the gateway  [required]
  -d, --description <description>
                                  Description of the network to be created
  --dns1 <ip>                     IP of the primary DNS server
  --dns2 <ip>                     IP of the secondary DNS server
  --dns-suffix <name>             DNS suffix
  --ip-range-start <ip>           Start address of the IP ranges used for
                                  static pool allocation in the network
  --ip-range-end <ip>             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 <integer>  Default lease in seconds for DHCP addresses
  --max-lease-time <integer>      Max lease in seconds for DHCP addresses
  --dhcp-ip-range-start <ip>      Start address of the IP range used for DHCP
                                  addresses
  --dhcp-ip-range-end <ip>        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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant