API tools faq
paste
Advertisement
Guest User

Untitled

a guest
Jun 27th, 2017
108
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
YAML 20.45 KB | None | 0 0
raw download clone embed print report
  1. ================================================================================
  2. List of the JSON parameters that you can use to prepare templates for upgrade of
  3. embedded and external deployments of the vCenter Server Appliance 5.5 and 6.0 to
  4. embedded and external deployments of the vCSA 6.5.
  5. --------------------------------------------------------------------------------
  6.     __version:
  7.        Set this field to "2.3.0".
  8.     ============================================================================
  9.     new.vcsa:
  10.        This subsection describes the new upgraded appliance that you want to
  11.         deploy.
  12.     ----------------------------------------------------------------------------
  13.         ========================================================================
  14.         esxi:
  15.            This subsection describes the ESXi host on which to deploy the
  16.             appliance. Required if you are deploying the appliance directly on
  17.             an ESXi host. Fill in either this subsection or the 'vc' subsection.
  18.         ------------------------------------------------------------------------
  19.             hostname:
  20.                The IP address or fully qualified domain name (FQDN) of the ESXi
  21.                 host. If an FQDN is provided, it has to be resolvable from the
  22.                 machine that is running the installer.
  23.                 Type: string
  24.             username:
  25.                The user name of a user with administrative privileges on the
  26.                 ESXi host.
  27.                 Type: string
  28.             password:
  29.                The password of the ESXi host user. If left blank, or omitted,
  30.                 you will be prompted to enter it at the command console during
  31.                 template verification.
  32.                 Type: string
  33.             deployment.network:
  34.                The network of the ESXi host to which to connect the new
  35.                 appliance. When the ESXi host has one network, you can omit this
  36.                 parameter.
  37.                 Type: string
  38.             datastore:
  39.                The datastore on which to store the files of the appliance. This
  40.                 value has to be either a specific datastore name, or a specific
  41.                 datastore in a datastore cluster. The datastore must be
  42.                 accessible from the ESXi host and must have at least 25 GB of
  43.                 free space. Otherwise, the new appliance might not power on.
  44.                 Type: string
  45.             port:
  46.                The port number of the ESXi host. The default value is 443.
  47.                 Type: integer
  48.         ========================================================================
  49.         vc:
  50.            This subsection describes the vCenter Server instance on which to
  51.             deploy the appliance. Required if you are deploying the appliance on
  52.             an ESXi host or DRS cluster from a vCenter Server inventory. Fill in
  53.             either this subsection or the 'esxi' subsection.
  54.         ------------------------------------------------------------------------
  55.             hostname:
  56.                The IP address or fully qualified domain name (FQDN) of the
  57.                 vCenter Server instance. If an FQDN is provided, it has to be
  58.                 resolvable from the machine that is running the installer.
  59.                 Type: string
  60.             username:
  61.                The user name of a user with administrative privileges or the
  62.                 Single Sign-On administrator on vCenter.
  63.                 Type: string
  64.             password:
  65.                The password of a user with administrative privileges or the
  66.                 Single Sign-On administrator on vCenter. If left blank, or
  67.                 omitted, you will be prompted to enter it at the command console
  68.                 during template verification.
  69.                 Type: string
  70.             deployment.network:
  71.                The network of the ESXi host to which to connect the new
  72.                 appliance. When the ESXi host has one network, you can omit this
  73.                 parameter.
  74.                 Type: string
  75.             datacenter:
  76.                The path to the data center in the vCenter Server inventory that
  77.                 contains either the ESXi host or the cluster where you want to
  78.                 deploy the appliance. If the datacenter is within a folder
  79.                 hierarchy, the parent folders must be included. For example,
  80.                 "datacenter": ["Parent Folder 1", "Parent Folder 2", ..., "My
  81.                Datacenter"]. The 'datacenter' value in the template must end
  82.                 with the data center's name. All names are case-sensitive.
  83.                 Specify the target ESXi host or cluster in the 'target'
  84.                 subsection.
  85.                 Type: string, array
  86.             datastore:
  87.                The datastore on which to store the files of the appliance. This
  88.                 value has to be either a specific datastore name, or a specific
  89.                 datastore in a datastore cluster. The datastore must be
  90.                 accessible from the vCenter Server data center and must have at
  91.                 least 25 GB of free space. Otherwise, the new appliance might
  92.                 not power on.
  93.                 Type: string
  94.             port:
  95.                The port number of the vCenter Server instance. The default
  96.                 value is 443.
  97.                 Type: integer
  98.             target:
  99.                The path to the specific ESXi host, or the DRS cluster, under
  100.                 the data center in the vCenter Server inventory where you want
  101.                 to deploy the appliance. If the ESXi or cluster is within a
  102.                 folder hierarchy, the parent folders must be included. For
  103.                 example, "target": "Parent Folder 1", "Parent Folder 2", ...,
  104.                 "My ESXi", or "target": "Parent Folder 1", "Parent Folder 2",
  105.                 ..., "My DRS Cluster". The 'target' value in the template must
  106.                 end with either the ESXi host's name or the cluster's name. All
  107.                 names are case-sensitive. The ESXi or cluster name must be the
  108.                 same as the name recorded in the vCenter inventory, i.e. if the
  109.                 name in the vCenter inventory is an IP address, FQDN cannot be
  110.                 provided here, and vice versa. Use 'vm.folder' if you want the
  111.                 deployed appliance to be listed in a different location within
  112.                 the data center's hierarchy.
  113.                 Type: string, array
  114.             vm.folder:
  115.                A VM folder in the vCenter Server data center to which to add
  116.                 the appliance.
  117.                 Type: string
  118.         ========================================================================
  119.         appliance:
  120.            This subsection describes the configuration parameters for the new
  121.             upgraded appliance.
  122.         ------------------------------------------------------------------------
  123.             thin.disk.mode:
  124.                To deploy the appliance with thin mode virtual disks, set the
  125.                 value to 'true'.
  126.                 Type: boolean (true or false)
  127.             deployment.option:
  128.                The type of appliance to deploy.
  129.                 Type: JSON string with one of the following values: "tiny",
  130.                 "tiny-lstorage", "tiny-xlstorage", "small", "small-lstorage",
  131.                 "small-xlstorage", "medium", "medium-lstorage",
  132.                 "medium-xlstorage", "large", "large-lstorage",
  133.                 "large-xlstorage", "xlarge", "xlarge-lstorage",
  134.                 "xlarge-xlstorage", "management-tiny",
  135.                 "management-tiny-lstorage", "management-tiny-xlstorage",
  136.                 "management-small", "management-small-lstorage",
  137.                 "management-small-xlstorage", "management-medium",
  138.                 "management-medium-lstorage", "management-medium-xlstorage",
  139.                 "management-large", "management-large-lstorage",
  140.                 "management-large-xlstorage", "management-xlarge",
  141.                 "management-xlarge-lstorage", "management-xlarge-xlstorage",
  142.                 "infrastructure"
  143.             image:
  144.                A local file path or URL to the vCenter Server Appliance 6.5
  145.                 installation package. The source is included in the installer
  146.                 ISO file.
  147.                 Type: string
  148.             name:
  149.                The name of the appliance to deploy.
  150.                 Type: string
  151.             ovftool.path:
  152.                A local file path to OVF Tool executable file.
  153.                 Type: string
  154.         ========================================================================
  155.         os:
  156.            This subsection describes the operating system configurations for
  157.             the new appliance.
  158.         ------------------------------------------------------------------------
  159.             ssh.enable:
  160.                To enable the SSH administrator login option of the appliance,
  161.                 set the value to 'true'. You can change this setting after
  162.                 deployment.
  163.                 Type: boolean (true or false)
  164.         ========================================================================
  165.         ovftool.arguments:
  166.            Use this subsection to add arbitrary arguments to the OVF Tool
  167.             command that the script generates. You do not need to fill it out in
  168.             most circumstances.
  169.         ------------------------------------------------------------------------
  170.             <OVF Tool argument name>:
  171.                Values entered for these keys are passed to OVF Tool without any
  172.                 verification of compatibility with other generated arguments as
  173.                 '--key=value'. Keys that are not arguments recognized by OVF
  174.                 Tool will cause the script to fail.
  175.                 Type: string, boolean (true or false)
  176.         ========================================================================
  177.         sso:
  178.            Single Sign-On options
  179.         ------------------------------------------------------------------------
  180.             site-name:
  181.                Name of the vCenter Single Sign-On site.
  182.                 Type: string
  183.         ========================================================================
  184.         temporary.network:
  185.            During upgrade, data is exported from the source appliance and
  186.             imported into a new appliance. The new appliance requires temporary
  187.             network settings during this process. After the export and import
  188.             complete, the new appliance assumes the network identity of the
  189.             source appliance and stops using the temporary network settings. The
  190.             network information provided for the temporary network must be
  191.             distinct from the networking identity of the source appliance, and
  192.             must provide connectivity between the source and the new appliance.
  193.         ------------------------------------------------------------------------
  194.             ip.family:
  195.                Network IP address family.
  196.                 Type: JSON string with one of the following values: "ipv4",
  197.                 "ipv6"
  198.             mode:
  199.                Network mode. Use this parameter to select how to allocate the
  200.                 IP address of the appliance.
  201.                 Type: JSON string with one of the following values: "static",
  202.                 "dhcp"
  203.             ip:
  204.                Network IP address. Required only if the mode is "static". Can
  205.                 be IPv4 or IPv6 based on the specified address family.
  206.                 Type: string
  207.             dns.servers:
  208.                A comma-separated list of IP addresses of DNS servers. Can be a
  209.                 JSON array such as ["1.2.3.4", "127.0.0.1"] or a serialized
  210.                 string such as "1.2.3.4,127.0.0.1". The DNS servers must be able
  211.                 to resolve the legacy vCenter Server's name.
  212.                 Type: string, array
  213.             prefix:
  214.                Network prefix length. Use only when the mode is 'static'.
  215.                 Remove if the mode is 'dhcp'. This is the number of bits set in
  216.                 the subnet mask; for instance, if the subnet mask is
  217.                 255.255.255.0, there are 24 bits in the binary version of the
  218.                 subnet mask, so the prefix length is 24. If used, the values
  219.                 must be in the inclusive range of 0 to 32 for IPv4 and 0 to 128
  220.                 for IPv6.
  221.                 Type: string
  222.             gateway:
  223.                The IP address of the default gateway. Can be "default" when
  224.                 using IPv6.
  225.                 Type: string
  226.             system.name:
  227.                Primary network identity. Can be either an IP address or a fully
  228.                 qualified domain name (FQDN).
  229.                 Type: string
  230.         ========================================================================
  231.         user-options:
  232.            This subsection lets you control aspects of upgrade for particular
  233.             components.
  234.         ------------------------------------------------------------------------
  235.             vcdb.migrateSet:
  236.                Set data migration option. The available values are 'core',
  237.                 'all', 'core_events_tasks'. The default value is 'all'.
  238.                 Type: string
  239.     ============================================================================
  240.     source.vc:
  241.        This section describes the source appliance that you want to upgrade and
  242.         the ESXi host on which the appliance is running.
  243.     ----------------------------------------------------------------------------
  244.         description:
  245.            This section describes the source appliance which you want to
  246.             upgrade and the ESXi host on which the appliance is running. If you
  247.             are using vSphere Update Manager (VUM), and want automated Migration
  248.             Assistant installation and execution on the Windows VUM machine, add
  249.             the 'source.vum' section.
  250.         ========================================================================
  251.         esxi:
  252.            This subsection describes the ESXi host on which the source
  253.             appliance is running.
  254.         ------------------------------------------------------------------------
  255.             hostname:
  256.                IP address or fully qualified domain name (FQDN) of the ESXi
  257.                 host.If an FQDN is provided, it has to be resolvable from the
  258.                 machine that is running the installer.
  259.                 Type: string
  260.             username:
  261.                Username of a user with administrative privileges on the ESXi
  262.                 host.
  263.                 Type: string
  264.             password:
  265.                Password of the administrative user on the ESXi host. If left
  266.                 blank, or omitted, you will be prompted to enter it at the
  267.                 command console during template verification.
  268.                 Type: string
  269.             port:
  270.                The port number of the ESXi host. The default value is 443.
  271.                 Type: integer
  272.         ========================================================================
  273.         vc.vcsa:
  274.            This subsection describes the source appliance that you want to
  275.             upgrade.
  276.         ------------------------------------------------------------------------
  277.             hostname:
  278.                IP address or fully qualified domain name (FQDN) of the source
  279.                 appliance. If an FQDN is provided, it has to be resolvable from
  280.                 the machine that is running the installer.
  281.                 Type: string
  282.             username:
  283.                vCenter Single Sign-On administrator user name of the source
  284.                 appliance. If you do not set this value, the default value is
  285.                 'administrator@<SSO domain-name>'.
  286.                 Type: string
  287.             password:
  288.                vCenter Single Sign-On administrator password of the source
  289.                 appliance. If left blank, or omitted, you will be prompted to
  290.                 enter it at the command console during template verification.
  291.                 Type: string
  292.             root.password:
  293.                Password of the operating system root user of the appliance. If
  294.                 left blank, or omitted, you will be prompted to enter it at the
  295.                 command console during template verification.
  296.                 Type: string
  297.     ============================================================================
  298.     source.vum:
  299.        This section describes the source VUM that you want to upgrade.
  300.     ----------------------------------------------------------------------------
  301.         ========================================================================
  302.         run.migration.assistant:
  303.            This subsection describes the os credentials of the source Windows
  304.             VUM installation and the ESXi host on which the source Windows VUM
  305.             is running. Provide this subsection only when you want to install
  306.             and run Migration Assistant automatically.
  307.         ------------------------------------------------------------------------
  308.             esxi.hostname:
  309.                IP address or fully qualified domain name (FQDN) of the ESXi
  310.                 host. If an FQDN is provided, it has to be resolvable from the
  311.                 machine that is running the installer.
  312.                 Type: string
  313.             esxi.username:
  314.                Username of a user with administrative privileges on the ESXi
  315.                 host.
  316.                 Type: string
  317.             esxi.password:
  318.                The password of the ESXi host user. If left blank, or omitted,
  319.                 you will be prompted to enter it at the command console during
  320.                 template verification.
  321.                 Type: string
  322.             esxi.port:
  323.                The port number of the ESXi host. The default value is 443.
  324.                 Type: integer
  325.             vum.hostname:
  326.                IP address or fully qualified domain name (FQDN) of the VUM
  327.                 host. If an FQDN is provided, it has to be resolvable from the
  328.                 machine that is running the installer.
  329.                 Type: string
  330.             vum.os.username:
  331.                Administrator username for the source VUM Windows operating
  332.                 system.
  333.                 Type: string
  334.             vum.os.password:
  335.                Administrator user password for the source VUM Windows operating
  336.                 system. If left blank, or omitted, you will be prompted to enter
  337.                 it at the command console during template verification.
  338.                 Type: string
  339.             export.dir:
  340.                Directory to export source configuration and data.
  341.                 Type: string
  342.     ============================================================================
  343.     ceip:
  344.        VMware Customer Experience Improvement Program (CEIP)
  345.     ----------------------------------------------------------------------------
  346.         description:
  347.            This product participates in VMware's Customer Experience
  348.             Improvement Program ('CEIP'). Details regarding the data collected
  349.             through CEIP and the purposes for which it is used by VMware are set
  350.             forth at the Trust & Assurance Center at
  351.             http://www.vmware.com/trustvmware/ceip.html. To join the CEIP for
  352.             this product, in the template, set 'ceip.enabled': true. To leave
  353.             the CEIP for this product, set 'ceip.enabled': false. Please confirm
  354.             your acknowledgement by passing in the parameter --acknowledge-ceip
  355.             in the command line.
  356.         ========================================================================
  357.         settings:
  358.            CEIP participation options
  359.         ------------------------------------------------------------------------
  360.             ceip.enabled:
  361.                This key describes the enabling option for the VMware's Customer
  362.                 Experience Improvement Program (CEIP). By default we have
  363.                 'ceip.enabled': true, which indicates that you are joining CEIP.
  364.                 If you prefer not to participate in the VMware's CEIP for this
  365.                 product, you must disable CEIP by setting 'ceip.enabled': false.
  366.                 You may join or leave VMware's CEIP for this product at any
  367.                 time.
  368.                 Type: boolean (true or false)
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!