How to use the Windows push install with a CSV file (Video) (4037191)

How to use the Windows push install with a CSV file (Video)

How to use the Windows push install with a CSV file

On the NetVault webui page under Configuration | Guided Configuration | Machines to have NetVault software installed <server_url>/configuration/clients/createdeploymenttask.html, the user has various options by which he can specify the target machines. One of these options is to use a file (via the option Choose Machines->From a file). This article describes the use and format of such an input file.

Modes of usage

The file can be used for the following purposes.

• To install NetVault software to remote machines
  • Install / upgrade NetVault Backup client software on a remote machine
  • Install / upgrade plug-ins on a remote machine
• To add existing NetVault machines as clients to the local server

Please see the video below for a demo of the push install using a CSV file:

Go to the NetVault webui page /configuration/clients/createdeploymenttask.html

Under Configuration | Guided Configuration | Machines to have NetVault software installed 

You can specify the target machines using the file options (option Choose Machines->From a file). 

Installing NetVault Backup client software

When installing or upgrading NetVault core on a remote machine, the various fields that can be used in the file are as follows.

If NetVault Backup software is being installed to the remote machine for the first time, or the NetVault Backup software is being upgraded on a machine that is not yet added as a client to the local server, then the server will attempt to add the remote machine as its client after installing the software. Some fields below specify the settings to use for this add-as-client stage.

• target
  • The field value is the network address of the remote machine - can be IP address or FQDN.
  • The NetVault server must be able to contact the machine using this address.
  • This is a mandatory field. If skipped, the data line from the csv file will be ignored.

 

• targettype
  • Currently allowed value is only the fixed string "machine".
  • This is an optional field, provided only for future compatibility.

 

• targetusername
  • The field value is the Windows user account to use to connect to the remote machine.
  • The format used for the value must be
    • \ for a domain user account, or
    • \ for a user account local to the remote machine.
  • This is a mandatory field.

 

• targetuserpassword
  • The field value is the password for the Windows user account specified in the field above (targetusername).
  • Any leading or trailing whitespace is treated as constituting the field value.
  • This is a mandatory field. If skipped, the software deployment may fail, depending on the password setting of the remote machine.

 

• nvlanguage
  • Can be one of English/ChineseSimp/French/German/Japanese/Korean. Case sensitive.
  • This is an optional field. Effective only for a new installation, and not for an upgrade.
  • If a value is not specified for a new installation, or not one of the above values, English will be used as default.

 

• nvmachname
  • NetVault Backup name to use for a new installation. Ignored for an upgrade.
  • Must not contain any spaces.
  • The existing restrictions for the NetVault Backup name, as outlined in the NetVault user documentation, still apply though they are not enforced.
  • For a new installation, if no value is specified, then the NETBIOS name of the remote Windows installation will be used as the NetVault Backup name. However, it is recommended that you provide a value.

 

• nvmachpassword
  • NetVault Backup password to use for a new installation. If NetVault Backup client software is being upgraded on the remote machine, and the machine is not yet added as a client, then this field must specify the current NetVault Backup password of the existing installation, so that the machine can be added as a client.
  • Any leading or trailing whitespace is treated as constituting the field value.
  • For a new installation, if the password is longer than 100 characters, or it contains any characters from the set below, then the installation will fail.

< > & # | / \\ \" \' : * . - ` ( ) [ ] { } $ @ ?

 

• nvinstallfolder
  • Path on the remote machine, to which NetVault core should be installed. Used only for a new installation, and not for an upgrade.
  • If a value is specified for the field, then the path must reference a valid drive on the remote machine. Else, the deployment will fail.
  • If a value is not specified for a new installation, then the path used by default will be C:\Program Files\Quest\NetVault Backup on a 32-bit OS installation, and C:\Program Files (x86)\Quest\NetVault Backup on a 64-bit OS installation.

 

• nvdesc
  • A string to use as description for the NetVault machine.
  • The field value will be ignored if the remote installation is already a client of the local server.

 

• nvclientgroup
  • A comma-separated list of one or more client groups to which the machine should be added.
  • If a client group is configured within NetVault to contain all clients, but is not included in the list above, the machine will still be added to such a client group.

 

• outsidefirewall
  • Value can be TRUE/t/FALSE/f. Case insensitive.
  • Defines whether the remote machine is separated from the server by a firewall.
  • The field value will be ignored if the remote installation is already a client of the local server.

 

• deviceslistenports (Listen ports for devices)
• devicesconnectports (Connect ports for devices)
• msgchannellistenports (Listen ports for NetVault Backup message channels)
• msgchannelconnectports (Connect ports for NetVault Backup message channels)
• ndmplistenports (Listen ports for NDMP data channels)
• ndmpconnectports (Connect ports for NDMP control channels)
• intermachineconnectports (Connect ports for intermachine setup)
  • Specifies the ports to configure to enable communication with the remote machine. The text in bold specifies the field names to use within the csv file, and the text in the brackets next to the field name specifies the purpose of the ports. Please refer to the NetVault user documentation for further details on these port categories.
  • These field values will be ignored if the remote installation is already a client of the local server.
  • These field values are used when the remote machine is outside firewall (i.e., the value for the field outsidefirewall above must be set to TRUE).
  • Port ranges can be specified as a comma-separated list (for example 20000, 20050) or a port range separated by a dash (for example 20000-20100) or a combination of both (for example 20000-20050, 20100).

 

Installing NetVault Backup client software - Example

 

target;targettype;targetusername;targetuserpassword;nvlanguage;nvmachname;nvmachpassword;nvinstallfolder;nvclientgroup;nvdesc;outsidefirewall;deviceslistenports;devicesconnectports;msgchannellistenports;msgchannelconnectports;ndmplistenports;ndmpconnectports;intermachineconnectports

 

mymachine.testdomain.local;machine; testdomain\administrator;testpassword;English;nv_finance;nvfinancepassword;c:\NetVault;default;Finance_NV_Server;TRUE;20000-20100;20000-20100;20000-20100;20000-20100;20000-20100;20000-20100;20000-20100,20300

10.11.27.50;machine;mypcname\administrator;mypassword;;nv_sales;nvsalespassword;;;Sales_NV_Server;FALSE;;;;;;;

 

Installing NetVault plug-ins

 

When installing or upgrading plug-ins on a remote machine, the various fields that can be used in the file are as follows.

• target
  • The field value is the network address of the remote machine - can be IP address or FQDN.
  • The NetVault server must be able to contact the machine using this address.
  • This is a mandatory field. If skipped, the data line from the csv file will be ignored.

 

• targettype
  • Currently allowed value is only the fixed string "machine".
  • This is an optional field, provided only for future compatibility.

 

• targetusername
  • The field value is the Windows user account to use to connect to the remote machine.
  • The format used for the value must be
    • \ for a domain user account, or
    • \ for a user account local to the remote machine.
  • This is a mandatory field.

 

• targetuserpassword
  • The field value is the password for the Windows user account specified in the field above (targetusername).
  • Any leading or trailing whitespace is treated as constituting the field value.
  • This is a mandatory field. If skipped, the software deployment may fail, depending on the password setting of the remote machine.

Any other fields mentioned in the section “Installing NetVault Backup client software“, if specified, will be ignored.

Installing NetVault plug-ins - Example

 

target;targettype;targetusername;targetuserpassword

 

mymachine.testdomain.local;machine; testdomain\administrator;testpassword

10.11.27.50;machine;mypcname\administrator;mypassword

 

Adding a NetVault installation as client

 

When adding exiting NetVault installations as clients, the various fields that can be used in the file are as follows.

• target
  • The field value is the network address of the remote machine - can be IP address or FQDN.
  • The NetVault server must be able to contact the machine using this address.
  • This is a mandatory field. If skipped, the data line from the csv file will be ignored.

 

• targettype
  • Currently allowed value is only the fixed string "machine".
  • This is an optional field, provided only for future compatibility.

 

• nvmachpassword
  • This field must specify the current NetVault Backup password of the existing installation, so that the machine can be added as a client.
  • Any leading or trailing whitespace is treated as constituting the field value.

 

• nvdesc
  • A string to use as description for the NetVault machine.

 

• nvclientgroup
  • A comma-separated list of one or more client groups to which the machine should be added.
  • If a client group is configured within NetVault to contain all clients, but is not included in the list above, the machine will still be added to such a client group.

 

• outsidefirewall
  • Value can be TRUE/t/FALSE/f. Case insensitive.
  • Defines whether the remote machine is separated from the server by a firewall.

 

• deviceslistenports (Listen ports for devices)
• devicesconnectports (Connect ports for devices)
• msgchannellistenports (Listen ports for NetVault Backup message channels)
• msgchannelconnectports (Connect ports for NetVault Backup message channels)
• ndmplistenports (Listen ports for NDMP data channels)
• ndmpconnectports (Connect ports for NDMP control channels)
• intermachineconnectports (Connect ports for intermachine setup)
  • Specifies the ports to configure to enable communication with the remote machine. The text in bold specifies the field names to use within the csv file, and the text in the brackets next to the field name specifies the purpose of the ports. Please refer to the NetVault user documentation for further details on these port categories.
  • These field values are used when the remote machine is outside firewall (i.e., the value for the field outsidefirewall above must be set to TRUE).
  • Port ranges can be specified as a comma-separated list (for example 20000, 20050) or a port range separated by a dash (for example 20000-20100) or a combination of both (for example 20000-20050, 20100).

Any other fields mentioned in the section “Installing NetVault Backup client software“, if specified, will be ignored.

Adding a NetVault installation as client - Example

 

target;targettype;nvmachpassword;nvclientgroup;nvdesc;outsidefirewall;deviceslistenports;devicesconnectports;msgchannellistenports;msgchannelconnectports;ndmplistenports;ndmpconnectports;intermachineconnectports

 

mymachine.testdomain.local;machine; nvfinancepassword;default;Finance_NV_Server;TRUE;20000-20100;20000-20100;20000-20100;20000-20100;20000-20100;20000-20100;20000-20100,20300

10.11.27.50;machine;nvsalespassword;;Sales_NV_Server;FALSE;;;;;;;

 

General • The file can have .csv or .txt extension. • The user can specify values for only a pre-defined set of fields, which are mentioned in the sections below. • The first line (or the header line) of the file must define the names of the fields. The subsequent lines (or the data lines) provide values for the corresponding fields. • The names and the values of the fields must be separated by a semi-colon. • The header line cannot contain an empty field name. • If the header line contains a field, but the user does not wish to specify value for that field on a given data line, he can choose to do so by leaving it empty. • Any leading or trailing whitespace in the fields is ignored, unless noted in the sections below. • The number of fields in the header and data lines must match.