From e1e13ec1e99461a1cbaa6a8aa8409a471eb9c17d Mon Sep 17 00:00:00 2001 From: Stuart Clements Date: Wed, 23 Aug 2017 09:35:34 +0200 Subject: [PATCH] Removing repetitive instruction to wrap options in quotes. (#611) * Removing repetitive instruction to wrap options in quotes. * Reversed order of note and para on env variables. * Removed link to options topic as no longer relevant * Added ops-user to list that might need quotes. --- .../vic_vsphere_admin/common_vic_options.md | 26 ++--- .../vic_vsphere_admin/deploy_vch_esxi.md | 2 +- .../vic_vsphere_admin/deploy_vch_vcenter.md | 2 +- .../ts_cli_argument_error.md | 12 +- .../vic_vsphere_admin/upgrade_vch_options.md | 10 +- .../vch_installer_examples.md | 23 ++-- .../vch_installer_options.md | 104 +++--------------- .../vic_vsphere_admin/vch_shell_access.md | 2 +- .../vic_vsphere_admin/vch_ssh_access.md | 2 +- 9 files changed, 51 insertions(+), 132 deletions(-) diff --git a/docs/user_doc/vic_vsphere_admin/common_vic_options.md b/docs/user_doc/vic_vsphere_admin/common_vic_options.md index 809c7de96b..6b99effd9d 100644 --- a/docs/user_doc/vic_vsphere_admin/common_vic_options.md +++ b/docs/user_doc/vic_vsphere_admin/common_vic_options.md @@ -2,6 +2,16 @@ This section describes the options that are common to all `vic-machine` commands. The common options that `vic-machine` requires relate to the vSphere environment in which you deployed the virtual container host (VCH), and to the VCH itself. +**NOTE**: Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. + +Option arguments that might require quotation marks include the following: + +- User names and passwords in `--target`, or in `--user` and `--password`. +- Datacenter names in `--target`. +- VCH names in `--name`. +- Datastore names and paths in `--image-store`. +- Cluster and resource pool names in `--compute-resource`. + You can set environment variables for the `--target`, `--user`, `--password`, and `--thumbprint` options. For information about setting environment variables, see [Set Environment Variables for Key `vic-machine` Options](vic_env_variables.md). ### `--target` ### @@ -13,8 +23,6 @@ The IPv4 address, fully qualified domain name (FQDN), or URL of the ESXi host or - If the target ESXi host is not managed by vCenter Server, provide the address of the host.
--target esxi_host_address
- If the target ESXi host is managed by vCenter Server, or if you deployed the VCH to a cluster, provide the address of vCenter Server.
--target vcenter_server_address
- You can include the user name and password in the target URL. The user account that you specify must have vSphere administrator privileges.
--target vcenter_or_esxi_username:password@vcenter_or_esxi_address
- - Wrap the user name or password in single quotes (Linux or Mac OS) or double quotes (Windows) if they include special characters.
'vcenter_or_esxi_usern@me':'p@ssword'@vcenter_or_esxi_address
If you do not include the user name in the target URL, you must specify the `user` option. If you do not specify the `password` option or include the password in the target URL, `vic-machine` prompts you to enter the password. - If you deployed the VCH on a vCenter Server instance that includes more than one datacenter, include the datacenter name in the target URL. If you include an invalid datacenter name, `vic-machine` fails and suggests the available datacenters that you can specify.
--target vcenter_server_address/datacenter_name
@@ -28,11 +36,6 @@ The ESXi host or vCenter Server user account with which to run the `vic-machine`
--user esxi_or_vcenter_server_username
-Wrap the user name in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes special characters. - -
--user 'esxi_or_vcenter_server_usern@me'
- - ### `--password` ### Short name: `-p` @@ -41,10 +44,6 @@ The password for the user account on the vCenter Server on which you deployed t
--password esxi_host_or_vcenter_server_password
-Wrap the password in single quotation marks (') on Mac OS and Linux and in double quotation (") marks on Windows if it includes special characters. - -
--password 'esxi_host_or_vcenter_server_p@ssword'
- ### `--thumbprint` ### Short name: None @@ -75,7 +74,6 @@ If you do not specify the `compute-resource` or `id` options and multiple possib * If the VCH is on a vCenter Server with more than one cluster, specify the name of the target cluster:
--compute-resource cluster_name
* If the VCH is in a specific resource pool on a standalone host that is managed by vCenter Server, specify the IPv4 address or FQDN of the target host and name of the resource pool:
--compute-resource host_name/resource_pool_name
* If the VCH is in a specific resource pool in a cluster, specify the names of the target cluster and the resource pool:
--compute-resource cluster_name/resource_pool_name
-* Wrap the resource names in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces:
--compute-resource 'cluster name'/'resource pool name'
### `--name` ### @@ -85,10 +83,6 @@ The name of the VCH. This option is mandatory if the VCH has a name other than t
--name vch_appliance_name
-Wrap the appliance name in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes spaces. - -
--name 'vch appliance name'
- ### `--id` ### Short name: None diff --git a/docs/user_doc/vic_vsphere_admin/deploy_vch_esxi.md b/docs/user_doc/vic_vsphere_admin/deploy_vch_esxi.md index d479af8929..2721088582 100644 --- a/docs/user_doc/vic_vsphere_admin/deploy_vch_esxi.md +++ b/docs/user_doc/vic_vsphere_admin/deploy_vch_esxi.md @@ -21,7 +21,7 @@ This topic provides instructions for deploying a virtual container host (VCH) to 2. Navigate to the directory that contains the `vic-machine` utility: 3. Run the `vic-machine create` command. - Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. In these examples, the password is wrapped in quotes because it contains `@`. + In these examples, the password is wrapped in quotes because it contains `@`. - Linux OS:
$ vic-machine-linux create
diff --git a/docs/user_doc/vic_vsphere_admin/deploy_vch_vcenter.md b/docs/user_doc/vic_vsphere_admin/deploy_vch_vcenter.md
index bef2789074..325b3e0b26 100644
--- a/docs/user_doc/vic_vsphere_admin/deploy_vch_vcenter.md
+++ b/docs/user_doc/vic_vsphere_admin/deploy_vch_vcenter.md
@@ -26,7 +26,7 @@ The vCenter Server instance to which you deploy the VCH must match the specifica
 2. Navigate to the directory that contains the `vic-machine` utility:
 3. Run the `vic-machine create` command.
 
-   Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. In these examples, the user name is wrapped in quotes because it contains `@`.
+   In these examples, the user name is wrapped in quotes because it contains `@`.
 
    - Linux OS:
       
$ vic-machine-linux create
diff --git a/docs/user_doc/vic_vsphere_admin/ts_cli_argument_error.md b/docs/user_doc/vic_vsphere_admin/ts_cli_argument_error.md
index 8c14d953ff..45005dbfaa 100644
--- a/docs/user_doc/vic_vsphere_admin/ts_cli_argument_error.md
+++ b/docs/user_doc/vic_vsphere_admin/ts_cli_argument_error.md
@@ -38,11 +38,9 @@ Wrap any arguments that contain spaces or special characters in single quotation
 Option arguments that might require quotation marks include the following:
 
 - User names and passwords in `--target`, or in `--user` and `--password`
-- Datacenter names in `--target`
-- VCH names in `--name`
-- Datastore names and paths in `--image-store` and `--volume-store`
+- Datacenter names in `--target`.
+- VCH names in `--name`.
+- Datastore names and paths in `--image-store` and `--volume-store`.
 - Network and port group names in all networking options.
-- Cluster and resource pool names in `--compute-resource`
-- Folder names in the paths for `--tls-cert-path`, --tls-server-cert, --tls-server-key, `--appliance-iso`, and `--bootstrap-iso`
-
-For information about when to use quotation marks for different options, see the descriptions of those options in [VCH Deployment Options](vch_installer_options.md).
\ No newline at end of file
+- Cluster and resource pool names in `--compute-resource`.
+- Folder names in the paths for `--tls-cert-path`, `--tls-server-cert`, `--tls-server-key`, `--appliance-iso`, and `--bootstrap-iso`.
\ No newline at end of file
diff --git a/docs/user_doc/vic_vsphere_admin/upgrade_vch_options.md b/docs/user_doc/vic_vsphere_admin/upgrade_vch_options.md
index 1bcc936c4c..90a40c9a62 100644
--- a/docs/user_doc/vic_vsphere_admin/upgrade_vch_options.md
+++ b/docs/user_doc/vic_vsphere_admin/upgrade_vch_options.md
@@ -4,6 +4,8 @@ The command line utility for vSphere Integrated Containers Engine, `vic-machine`
 
 The `vic-machine upgrade` command includes the following options in addition to the common options described in [Common `vic-machine` Options](common_vic_options.md).
 
+**NOTE**: Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. 
+
 ### `--appliance-iso` ###
 
 Short name: `--ai`
@@ -14,10 +16,6 @@ The path to the new version of the ISO image from which to upgrade the VCH appli
 
 
--appliance-iso path_to_ISO_file/ISO_file_name.iso
-Wrap the folder names in the path in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces. - -
--appliance-iso 'path to ISO file'/appliance.iso
- ### `--bootstrap-iso` ### Short name: `--bi` @@ -28,10 +26,6 @@ The path to the new version of the ISO image from which to upgrade the container
--bootstrap-iso path_to_ISO_file/bootstrap.iso
-Wrap the folder names in the path in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces. - -
--bootstrap-iso 'path to ISO file'/ISO_file_name.iso
- ### `--force` ### Short name: `-f` diff --git a/docs/user_doc/vic_vsphere_admin/vch_installer_examples.md b/docs/user_doc/vic_vsphere_admin/vch_installer_examples.md index c4b565cfce..2d3cb8fd83 100644 --- a/docs/user_doc/vic_vsphere_admin/vch_installer_examples.md +++ b/docs/user_doc/vic_vsphere_admin/vch_installer_examples.md @@ -27,6 +27,18 @@ For simplicity, these examples use the `--force` option to disable the verificat For detailed descriptions of all of the `vic-machine create` options, see [VCH Deployment Options](vch_installer_options.md). +**NOTE**: Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. + +Option arguments that might require quotation marks include the following: + +- User names and passwords in `--target`, `--user`, `--password`, `--ops-user`, and `--ops-password`. +- Datacenter names in `--target`. +- VCH names in `--name`. +- Datastore names and paths in `--image-store` and `--volume-store`. +- Network and port group names in all networking options. +- Cluster and resource pool names in `--compute-resource`. +- Folder names in the paths for `--tls-cert-path`, `--tls-server-cert`, `--tls-server-key`, `--appliance-iso`, and `--bootstrap-iso`. + ## General Deployment Examples @@ -43,7 +55,7 @@ When deploying a VCH to vCenter Server, you must use the `--bridge-network` opti This example deploys a VCH with the following configuration: -- Provides the vCenter Single Sign-On user and password in the `--target` option. Note that the user name is wrapped in quotes, because it contains the `@` character. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. +- Provides the vCenter Single Sign-On user and password in the `--target` option. The user name is wrapped in quotes, because it contains the `@` character. - Deploys a VCH named `vch1` to the cluster `cluster1` in datacenter `dc1`. - Uses a port group named `vic-bridge` for the bridge network. - Designates `datastore1` as the datastore in which to store container images, the files for the VCH appliance, and container VMs. @@ -86,7 +98,7 @@ To deploy a VCH in a specific resource pool on an ESXi host that is not managed This example deploys a VCH with the following configuration: - Specifies the user name and password, image store, and a name for the VCH. -- Designates `rp 1` as the resource pool in which to place the VCH. Note that the resource pool name is wrapped in quotes, because it contains a space. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. +- Designates `rp 1` as the resource pool in which to place the VCH. The resource pool name is wrapped in quotes, because it contains a space.
vic-machine-operating_system create
 --target root:password@esxi_host_address
@@ -129,8 +141,6 @@ If the name of the resource pool is not unique across all clusters, for example
 --no-tls
 
-Note that the resource pool and cluster names in these examples are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. - ### Set Limits on Resource Use To limit the amount of system resources that the container VMs in a VCH can use, you can set resource limits on the VCH vApp. @@ -177,7 +187,7 @@ In addition to the mandatory bridge network, if your vCenter Server environment This example deploys a VCH with the following configuration: - Specifies the user name, password, datacenter, cluster, image store, bridge network, and name for the VCH. -- Directs public and management traffic to network 1 and Docker API traffic to network 2. Note that the network names are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. +- Directs public and management traffic to network 1 and Docker API traffic to network 2.
vic-machine-operating_system create
 --target 'Administrator@vsphere.local':password@vcenter_server_address/dc1
@@ -202,7 +212,7 @@ If you specify networks for any or all of the public, management, and client net
 This example deploys a VCH with the following configuration:
 
 - Specifies the user name, password, datacenter, cluster, image store, bridge network, and name for the VCH.
-- Directs public and management traffic to network 1 and Docker API traffic to network 2. Note that the network names are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.
+- Directs public and management traffic to network 1 and Docker API traffic to network 2.
 - Sets a DNS server for use by the public, management, and client networks.
 - Sets a static IP address and subnet mask for the VCH endpoint VM on the public and client networks. Because the management network shares a network with the public network, you only need to specify the public network IP address. You cannot specify a management IP address because you are sharing a port group between the management and public network.
 - Specifies the gateway for the public network. If you set a static IP address on the public network, you must also specify the gateway address.
@@ -295,7 +305,6 @@ This example deploys a VCH with the following configuration:
 - Specifies the user name, password, datacenter, cluster, bridge network, and name for the VCH.
 - Specifies the `volumes` folder on `datastore 1` as the default volume store. Creating a volume store named `default` allows container application developers to create anonymous or named volumes by using `docker create -v`. 
 - Specifies a second volume store named `volume_store_2` in the `volumes` folder on `datastore 2`. 
-- Note that the datastore names are wrapped in quotes, because they contain spaces. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system.
 
 
vic-machine-operating_system create
 --target 'Administrator@vsphere.local':password@vcenter_server_address/dc1
diff --git a/docs/user_doc/vic_vsphere_admin/vch_installer_options.md b/docs/user_doc/vic_vsphere_admin/vch_installer_options.md
index e0e167ed7a..a55d3b6717 100644
--- a/docs/user_doc/vic_vsphere_admin/vch_installer_options.md
+++ b/docs/user_doc/vic_vsphere_admin/vch_installer_options.md
@@ -17,6 +17,18 @@ To allow you to fine-tune the deployment of VCHs, `vic-machine create` provides
 - [Advanced Resource Management Options](#adv-mgmt)
 - [Other Advanced Options](#adv-other)
 
+**NOTE**: Wrap any option arguments that include spaces or special characters in quotes. Use single quotes if you are using `vic-machine` on a Linux or Mac OS system and double quotes on a Windows system. 
+
+Option arguments that might require quotation marks include the following:
+
+- User names and passwords in `--target`, or in `--user` and `--password`.
+- Datacenter names in `--target`.
+- VCH names in `--name`.
+- Datastore names and paths in `--image-store` and `--volume-store`.
+- Network and port group names in all networking options.
+- Cluster and resource pool names in `--compute-resource`.
+- Folder names in the paths for `--tls-cert-path`, `--tls-server-cert`, `--tls-server-key`, `--appliance-iso`, and `--bootstrap-iso`.
+
 
 ## vSphere Target Options 
 
@@ -35,8 +47,6 @@ To facilitate IP address changes in your infrastructure, provide an FQDN wheneve
 - If the target ESXi host is not managed by vCenter Server, provide the address of the ESXi host.
--target esxi_host_address
- If the target ESXi host is managed by vCenter Server, or if you are deploying to a cluster, provide the address of vCenter Server.
--target vcenter_server_address
- You can include the user name and password in the target URL. If you are deploying a VCH on vCenter Server, specify the username for an account that has the Administrator role on that vCenter Server instance.
--target vcenter_or_esxi_username:password@vcenter_or_esxi_address
- - Wrap the user name or password in single quotes (Linux or Mac OS) or double quotes (Windows) if they include special characters.
'vcenter_or_esxi_usern@me':'p@ssword'@vcenter_or_esxi_address
If you do not include the user name in the target URL, you must specify the `user` option. If you do not specify the `password` option or include the password in the target URL, `vic-machine create` prompts you to enter the password. @@ -46,9 +56,6 @@ To facilitate IP address changes in your infrastructure, provide an FQDN wheneve
--target vcenter_server_address/datacenter_name
- Wrap the datacenter name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes spaces. -
--target vcenter_server_address/'datacenter name'
- ### `--user` ### Short name: `-u` @@ -59,10 +66,6 @@ If you are deploying a VCH on vCenter Server, specify a username for an account
--user esxi_or_vcenter_server_username
-Wrap the user name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes special characters. - -
--user 'esxi_or_vcenter_server_usern@me'
- You can specify the username in the URL that you pass to `vic-machine create` in the `target` option, in which case the `user` option is not required. You can configure a VCH so that it uses a non-administrator account for post-deployment operations by specifying the [`--ops-user`](#--ops-user) option. If you do not specify `--ops-user`, VCHs use the vSphere administrator account that you specify in `--user` for general post-deployment operations. @@ -75,10 +78,6 @@ The password for the user account on the vCenter Server on which you are deploy
--password esxi_host_or_vcenter_server_password
-Wrap the password in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes special characters. - -
--password 'esxi_host_or_vcenter_server_p@ssword'
- You can also specify the username and password in the URL that you pass to `vic-machine create` in the `target` option, in which case the `password` option is not required. ### `--compute-resource` ### @@ -102,7 +101,6 @@ If you do not specify the `--compute-resource` option and multiple possible reso * To deploy to a specific resource pool on a standalone host that is managed by vCenter Server, or to a specific resource pool in a cluster, if the resource pool name is unique across all hosts and clusters, specify the name of the resource pool:
--compute-resource resource_pool_name
* To deploy to a specific resource pool on a standalone host that is managed by vCenter Server, if the resource pool name is not unique across all hosts, specify the IPv4 address or FQDN of the target host and name of the resource pool:
--compute-resource host_name/resource_pool_name
* To deploy to a specific resource pool in a cluster, if the resource pool name is not unique across all clusters, specify the full path to the resource pool:
--compute-resource cluster_name/Resources/resource_pool_name
-* Wrap resource names in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if they include spaces:
--compute-resource 'resource pool name'
--compute-resource 'cluster name'/Resources/'resource pool name'
### `--thumbprint` @@ -237,13 +235,6 @@ The path to a custom X.509 server certificate. This certificate identifies the V --tls-server-key path_to_key_file/key_file_name.pem
-Wrap the folder names in the paths in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces. - -
--tls-server-cert 'path to certificate file'/certificate_file_name.pem 
---tls-server-key 'path to key file'/key_file_name.pem
-
- - #### `--tls-server-key` Short name: none @@ -256,12 +247,6 @@ The path to the private key file to use with a custom server certificate. This o --tls-server-key path_to_key_file/key_file_name.pem
-Wrap the folder names in the paths in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces. - -
--tls-server-cert 'path to certificate file'/certificate_file_name.pem 
---tls-server-key 'path to key file'/key_file_name.pem
-
- #### `--tls-ca` Short name: `--ca` @@ -318,10 +303,6 @@ A vSphere user account with which the VCH runs after deployment. If not specifie
--ops-user user_name
-Wrap the user name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes special characters. - -
--ops-user 'user_n@me'
- The user account that you specify in `--ops-user` must exist before you deploy the VCH. For information about the permissions that the `--ops-user` account requires, see [Use Different User Accounts for VCH Deployment and Operation](set_up_ops_user.md). #### `--ops-password` ### @@ -332,11 +313,6 @@ The password or token for the operations user that you specify in `--ops-user`.
--ops-password password
-Wrap the password in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes special characters. - -
--ops-password 'p@ssword'
- - ## Private Registry Options If you use vSphere Integrated Containers Registry, or if container developers need to access Docker images that are stored in other private registry servers, you must configure VCHs to allow them to connect to these private registry servers when you deploy the VCHs. VCHs can connect to both secure and insecure private registry servers. @@ -413,7 +389,7 @@ You can specify a datastore folder to use as the image store by specifying a pat
--image-store datastore_name/path
-If the folder that you specify in `/path` does not already exist, `vic-machine create` creates it. Wrap the datastore name and path in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if they include spaces:
--image-store 'datastore name'/'datastore path'
+If the folder that you specify in `/path` does not already exist, `vic-machine create` creates it. If you designate a datastore folder as the image store, `vic-machine` creates the following set of folders in the target datastore: @@ -458,9 +434,6 @@ If you specify an invalid datastore name, `vic-machine create` fails and suggest - If you specify the target datastore, a datastore path, and the volume store label, `vic-machine create` creates a folder named `volumes` in the location that you specify in the datastore path. Any volumes that container developers create will appear in the path/volumes folder.
--volume-store datastore_name/datastore_path:volume_store_label
-- Wrap the datastore name and path in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if they include spaces. The volume store label cannot include spaces. - -
--volume-store 'datastore name'/'datastore path':volume_store_label
- You can specify the `volume-store` option multiple times, to create multiple volume stores for the VCH.
--volume-store datastore_name/path:volume_store_label_1
@@ -509,10 +482,6 @@ The `bridge-network` option is **optional** when you are deploying a VCH to an E
 
 
--bridge-network port_group_name
-Wrap the port group name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes spaces. - -
--bridge-network 'port group name'
- If you intend to use the [`--ops-user`](#ops-user) option to use different user accounts for deployment and operation of the VCH, you must place the bridge network port group in a network folder that has the `Read-Only` role with propagation enabled. For more information about the requirements when using `--ops-user`, see [Use Different User Accounts for VCH Deployment and Operation](set_up_ops_user.md). For information about how to specify a range of IP addresses for additional bridge networks, see [`bridge-network-range`](#bridge-range) in Advanced Networking Options. @@ -528,11 +497,6 @@ If not specified, the VCH uses the public network for client traffic. If you spe
--client-network port_group_name
-Wrap the port group name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes spaces. - -
--client-network 'port group name'
- - ### `--public-network` Short name: `--pn` @@ -545,11 +509,6 @@ If not specified, containers use the VM Network for public network traffic. If y
--public-network port_group
-Wrap the network name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes spaces. - -
--public-network 'port group name'
- - ### `--management-network` Short name: `--mn` @@ -579,10 +538,6 @@ If not specified, the VCH uses the public network for management traffic. If you
--management-network port_group_name
-Wrap the network name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes spaces. - -
--management-network 'port group name'
- ### `--container-network` @@ -605,7 +560,7 @@ If you specify an invalid port group name, `vic-machine create` fails and sugges - You cannot use the same port group as you use for the bridge network. - You can create the port group on the same distributed virtual switch as the port group that you use for the bridge network. - If the port group that you specify in the `container-network` option does not support DHCP, see [Configure Container Networks](#adv-container-net) in Advanced Options. -- The descriptive name appears under `Networks` when you run `docker info` or `docker network ls` on the deployed VCH. +- The descriptive name appears under `Networks` when you run `docker info` or `docker network ls` on the deployed VCH. The descriptive name cannot include spaces. - Container developers use the descriptive name in the `--net` option when they run `docker run` or `docker create`. You can specify `--container-network` multiple times to add multiple vSphere networks to Docker. @@ -614,10 +569,6 @@ If you do not specify `--container-network`, or if you deploy containers that do
--container-network port_group_name:container_port _group_name
-Wrap the port group name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes spaces. The descriptive name cannot include spaces. - -
--container-network 'port group name':container port group name
- If you intend to use the [`--ops-user`](#ops-user) option to use different user accounts for deployment and operation of the VCH, you must place any container network port groups in a network folder that has the `Read-Only` role with propagation enabled. For more information about the requirements when using `--ops-user`, see [Use Different User Accounts for VCH Deployment and Operation](set_up_ops_user.md). ## General Deployment Options @@ -632,10 +583,6 @@ A name for the VCH. If not specified, `vic-machine` sets the name of the VCH to
--name vch_name
-Wrap the name in single quotes (') on Mac OS and Linux and in double quotes (") on Windows if it includes spaces. - -
--name 'vch name'
- ### `--memory` ### Short name: `--mem` @@ -751,9 +698,6 @@ In the following example, `--management-network-gateway` informs the VCH that it
--management-network-gateway 192.168.3.0,192.168.128.0:192.168.2.1
- - - ## Configure Container Networks If the network that you specify in the `container-network` option does not support DHCP, you must specify the `container-network-gateway` option. You can optionally specify one or more DNS servers and a range of IP addresses for container VMs on the container network. @@ -770,10 +714,6 @@ When you specify the container network gateway, you must use the port group that
--container-network-gateway port_group_name:gateway_ip_address/subnet_mask
-Wrap the port group name in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes spaces. - -
--container-network-gateway 'port group name':gateway_ip_address/subnet_mask
- ### `--container-network-dns` ### Short name: `--cnd` @@ -784,10 +724,6 @@ When you specify the container network DNS server, you must use the port group
--container-network-dns port_group_name:8.8.8.8
-Wrap the port group name in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes spaces. - -
--container-network-dns 'port group name':8.8.8.8
- ### `--container-network-ip-range` Short name: `--cnr` @@ -802,10 +738,6 @@ You can also specify the IP range as a CIDR.
--container-network-ip-range port_group_name:192.168.100.0/24
-Wrap the port group name in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes spaces. - -
--container-network-ip-range 'port group name':192.168.100.0/24
- ### `--container-network-firewall` Short name: `--cnf` @@ -943,10 +875,6 @@ The path to the ISO image from which the VCH appliance boots. Set this option if
--appliance-iso path_to_ISO_file/appliance.iso
-Wrap the folder names in the path in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces. - -
--appliance-iso 'path to ISO file'/appliance.iso
- ### `--bootstrap-iso` ### Short name: `--bi` @@ -957,10 +885,6 @@ The path to the ISO image from which to boot container VMs. Set this option if y
--bootstrap-iso path_to_ISO_file/bootstrap.iso
-Wrap the folder names in the path in single quotes (Linux or Mac OS) or double quotes (Windows) if they include spaces. - -
--bootstrap-iso 'path to ISO file'/bootstrap.iso
- ### `--use-rp` ### Short name: none diff --git a/docs/user_doc/vic_vsphere_admin/vch_shell_access.md b/docs/user_doc/vic_vsphere_admin/vch_shell_access.md index 8b23740638..e26f3a4ad1 100644 --- a/docs/user_doc/vic_vsphere_admin/vch_shell_access.md +++ b/docs/user_doc/vic_vsphere_admin/vch_shell_access.md @@ -12,7 +12,7 @@ In addition to the [Common `vic-machine` Options](common_vic_options.md), `vic-m - You must specify the ID or name of the VCH to debug. - You might need to provide the thumbprint of the vCenter Server or ESXi host certificate. Use upper-case letters and colon delimitation in the thumbprint. Do not use space delimitation. -- You enable shell access by specifying a password for the root user on the VCH endpoint VM in the `--rootpw` option. Setting a password on the VCH allows you to access the VCH by using the VM console. If you also set the `--enable-ssh` option, you can use this password to connect to the VCH by using SSH. Wrap the password in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes shell characters such as `$`, `!` or `%`.
--rootpw 'new_p@ssword'
+- You enable shell access by specifying a password for the root user on the VCH endpoint VM in the `--rootpw` option. Setting a password on the VCH allows you to access the VCH by using the VM console. If you also set the `--enable-ssh` option, you can use this password to connect to the VCH by using SSH. Wrap the password in quotes if it includes shell characters such as `$`, `!` or `%`.
--rootpw 'new_p@ssword'
- When you use the password to log in to a VCH, you see the message that the password will expire in 0 days. To obtain a longer expiration period, use the Linux `passwd` command in the endpoint VM to set a new password. If the password expires, the VCH does not revert to the default security configuration from before you ran `vic-machine debug`. If you attempt to log in using an interactive password via the terminal or SSH, you see a prompt to change the password. If you are using an SSH key, you cannot log in until you either change the password or run `vic-machine debug` again. diff --git a/docs/user_doc/vic_vsphere_admin/vch_ssh_access.md b/docs/user_doc/vic_vsphere_admin/vch_ssh_access.md index a08de36460..f4491b0934 100644 --- a/docs/user_doc/vic_vsphere_admin/vch_ssh_access.md +++ b/docs/user_doc/vic_vsphere_admin/vch_ssh_access.md @@ -9,7 +9,7 @@ You can use the `vic-machine debug` command to enable shell access to a virtual The credentials that you provide must have the following privilege on the endpoint VM:
Virtual machine.Guest Operations.Guest Operation Program Execution
- You must specify the ID or name of the VCH to debug. - You might need to provide the thumbprint of the vCenter Server or ESXi host certificate. Use upper-case letters and colon delimitation in the thumbprint. Do not use space delimitation. -- To enable SSH access, you mush enable shell access by specifying the `--rootpw` option. Wrap the password in single quotes (Linux or Mac OS) or double quotes (Windows) if it includes shell characters such as `$`, `!` or `%`. +- To enable SSH access, you mush enable shell access by specifying the `--rootpw` option. Wrap the password in quotes if it includes shell characters such as `$`, `!` or `%`. - You authorize SSH access by specifying `--enable-ssh`. The `sshd` service runs until the VCH endpoint VM reboots. The `--enable-ssh` option takes no arguments. - If you have already enabled SSH access but the password that you set has expired, and you then rerun `--enable-ssh` without specifying `--rootpw`, the password expiry is set to 1 day in the future and the password is preserved. - Optionally, you can specify the `--authorized-key` option to upload a public key file to `/root/.ssh/authorized_keys` folder in the endpoint VM. Include the name of the `*.pub` file in the path.
--authorized-key path_to_public_key_file/key_file.pub