Veritas NetBackup™ Commands Reference Guide

Last Published:
Product(s): NetBackup (8.2)
  1. Introduction
    1.  
      About NetBackup commands
    2.  
      Navigating multiple menu levels
    3.  
      NetBackup command conventions
    4.  
      NetBackup Media Manager command notes
    5.  
      IPV6 updates
  2. Appendix A. NetBackup Commands
    1.  
      acsd
    2.  
      add_media_server_on_clients
    3.  
      backupdbtrace
    4.  
      backuptrace
    5.  
      bmrc
    6.  
      bmrconfig
    7.  
      bmrepadm
    8.  
      bmrprep
    9.  
      bmrs
    10.  
      bmrsrtadm
    11.  
      bp
    12.  
      bparchive
    13.  
      bpbackup
    14.  
      bpbackupdb
    15.  
      bpcatarc
    16.  
      bpcatlist
    17.  
      bpcatres
    18.  
      bpcatrm
    19.  
      bpcd
    20.  
      bpchangeprimary
    21.  
      bpclient
    22.  
      bpclimagelist
    23.  
      bpclntcmd
    24.  
      bpclusterutil
    25.  
      bpcompatd
    26.  
      bpconfig
    27.  
      bpdbjobs
    28.  
      bpdbm
    29.  
      bpdgclone
    30.  
      bpdown
    31.  
      bpduplicate
    32.  
      bperror
    33.  
      bpexpdate
    34.  
      bpfis
    35.  
      bpflist
    36.  
      bpgetconfig
    37.  
      bpgetdebuglog
    38.  
      bpimage
    39.  
      bpimagelist
    40.  
      bpimmedia
    41.  
      bpimport
    42.  
      bpinst
    43.  
      bpkeyfile
    44.  
      bpkeyutil
    45.  
      bplabel
    46.  
      bplist
    47.  
      bpmedia
    48.  
      bpmedialist
    49.  
      bpminlicense
    50.  
      bpnbat
    51.  
      bpnbaz
    52.  
      bppficorr
    53.  
      bpplcatdrinfo
    54.  
      bpplclients
    55.  
      bppldelete
    56.  
      bpplinclude
    57.  
      bpplinfo
    58.  
      bppllist
    59.  
      bpplsched
    60.  
      bpplschedrep
    61.  
      bpplschedwin
    62.  
      bppolicynew
    63.  
      bpps
    64.  
      bprd
    65.  
      bprecover
    66.  
      bprestore
    67.  
      bpretlevel
    68.  
      bpschedule
    69.  
      bpschedulerep
    70.  
      bpsetconfig
    71.  
      bpstsinfo
    72.  
      bpstuadd
    73.  
      bpstudel
    74.  
      bpstulist
    75.  
      bpsturep
    76.  
      bptestbpcd
    77.  
      bptestnetconn
    78.  
      bptpcinfo
    79.  
      bpup
    80.  
      bpverify
    81.  
      cat_convert
    82.  
      cat_export
    83.  
      cat_import
    84.  
      configureCertsForPlugins
    85.  
      configureMQ
    86.  
      configurePorts
    87.  
      configureWebServerCerts
    88.  
      create_nbdb
    89.  
      csconfig cldinstance
    90.  
      csconfig cldprovider
    91.  
      csconfig meter
    92.  
      csconfig throttle
    93.  
      csconfig reinitialize
    94.  
      duplicatetrace
    95.  
      importtrace
    96.  
      jbpSA
    97.  
      jnbSA
    98.  
      ltid
    99.  
      manageClientCerts
    100.  
      mklogdir
    101.  
      nbauditreport
    102.  
      nbcatsync
    103.  
      NBCC
    104.  
      NBCCR
    105.  
      nbcertcmd
    106.  
      nbcertupdater
    107.  
      nbcldutil
    108.  
      nbcloudrestore
    109.  
      nbcomponentupdate
    110.  
      nbcplogs
    111.  
      nbdb_admin
    112.  
      nbdb_backup
    113.  
      nbdb_move
    114.  
      nbdb_ping
    115.  
      nbdb_restore
    116.  
      nbdb_unload
    117.  
      nbdbms_start_server
    118.  
      nbdbms_start_stop
    119.  
      nbdc
    120.  
      nbdecommission
    121.  
      nbdelete
    122.  
      nbdeployutil
    123.  
      nbdevconfig
    124.  
      nbdevquery
    125.  
      nbdiscover
    126.  
      nbdna
    127.  
      nbemm
    128.  
      nbemmcmd
    129.  
      nbfindfile
    130.  
      nbfirescan
    131.  
      nbftadm
    132.  
      nbftconfig
    133.  
      nbgetconfig
    134.  
      nbhba
    135.  
      nbholdutil
    136.  
      nbhostidentity
    137.  
      nbhostmgmt
    138.  
      nbhypervtool
    139.  
      nbimageshare
    140.  
      nbinstallcmd
    141.  
      nbjm
    142.  
      nbkmsutil
    143.  
      nboraadm
    144.  
      nborair
    145.  
      nbpem
    146.  
      nbpemreq
    147.  
      nbperfchk
    148.  
      nbplupgrade
    149.  
      nbrb
    150.  
      nbrbutil
    151.  
      nbregopsc
    152.  
      nbreplicate
    153.  
      nbrepo
    154.  
      nbrestorevm
    155.  
      nbseccmd
    156.  
      nbsetconfig
    157.  
      nbsnapimport
    158.  
      nbsnapreplicate
    159.  
      nbsqladm
    160.  
      nbstl
    161.  
      nbstlutil
    162.  
      nbstop
    163.  
      nbsu
    164.  
      nbsvrgrp
    165.  
      resilient_clients
    166.  
      restoretrace
    167.  
      stopltid
    168.  
      tl4d
    169.  
      tl8d
    170.  
      tl8cd
    171.  
      tldd
    172.  
      tldcd
    173.  
      tlhd
    174.  
      tlhcd
    175.  
      tlmd
    176.  
      tpautoconf
    177.  
      tpclean
    178.  
      tpconfig
    179.  
      tpext
    180.  
      tpreq
    181.  
      tpunmount
    182.  
      verifytrace
    183.  
      vltadm
    184.  
      vltcontainers
    185.  
      vlteject
    186.  
      vltinject
    187.  
      vltoffsitemedia
    188.  
      vltopmenu
    189.  
      vltrun
    190.  
      vmadd
    191.  
      vmchange
    192.  
      vmcheckxxx
    193.  
      vmd
    194.  
      vmdelete
    195.  
      vmoprcmd
    196.  
      vmphyinv
    197.  
      vmpool
    198.  
      vmquery
    199.  
      vmrule
    200.  
      vmupdate
    201.  
      vnetd
    202.  
      vssat
    203.  
      vwcp_manage
    204.  
      vxlogcfg
    205.  
      vxlogmgr
    206.  
      vxlogview
    207.  
      W2KOption

Name

csconfig cldinstance — the cldinstance option for the csconfig command sets and fetches the cloud instance configuration settings.

SYNOPSIS


Synopsis information for Amazon S3

csconfig cldinstance

[-a -in instance_name -pt provider_type -sh service_host_name [-se service_endpoint_path] [-access_style access_style_type] [-http_port port_no] [-https_port port_no]]

[-ar -in instance_name -lc location_constraint [,location_constraint,location_constraint] -rn region_name [,region_name,region_name] -sh service_host [,service_host,service_host]]

[-as -in instance_name -sts storage_server_name [-storage_class storage_class] [-obj_size object_size] [-ssl 0|1|2] [-crl 0|1] [-pxtype proxy_type -pxhost proxy_host -pxport proxy_port [-pxtunnel proxytunnel_usage] [-pxauth_type proxy_auth_type [-pxuser_name proxy_user_name ]]] [-lc location_constraint,location_constraint] [-creds_broker creds_broker -url service_url -mission mission -agency agency -role role -cert_file cert_file_name -key_file private_key_file_name [-key_pass private_key_passphrase]]]]

[-at api_type]

[-i [-pt provider_type | -at api_type | -in instance_name]]

[-l [-pt provider_type | -at api_type]

[-r -in instance_name]

[-rr -lc location_constraint [,location_constraint,location_constraint] -in instance_name]

[-rs -in instance_name -sts storage_server_name]

[-u -in instance_name [-sh service_host_name] [-se service_endpoint_path] [-http_port port_no] [-https_port port_no] [-access_style access_style_type]]

[-ur -in instance_name -lc location_constraint] -rn region_name -sh service_host_name

[-us -in instance_name -sts storage_server_name [-ssl ssl_usage] [-crl crl_usage] [-lc location_constraint,location_constraint [-auth_lc authentication_location_constraint] [-del_lc location_constraint [,location_constraint,location_constraint]] [-pxtype proxy_type -pxhost proxy_host -pxport proxy_port [-pxtunnel proxytunnel_usage] [-pxauth_type proxy_auth_type [-pxuser_name proxy_user_name]]] [-url service_url -mission mission1 -agency agency1 -role role1 -cert_file cert_file_name1 -key_file private_key_file_name1 [-key_pass private_key_passphrase]]]

Synopsis information for Microsoft Azure

[-as -in instance_name -sts storage_server_name [-storage_tier storage_tier] [-ssl 0|1|2] [-crl 0|1] [-pxtype proxy_type -pxhost proxy_host -pxport proxy_port [-pxtunnel proxytunnel_usage] [-pxauth_type proxy_auth_type [-pxuser_name proxy_user_name ]]]

[-at api_type]

[-i [-pt provider_type | -at api_type | -in instance_name]]

[-l [-pt provider_type | -at api_type]

[-rs -in instance_name -sts storage_server_name]

[-us -in instance_name -sts storage_server_name [-ssl ssl_usage] [-crl crl_usage] [-pxtype proxy_type -pxhost proxy_host -pxport proxy_port [-pxtunnel proxytunnel_usage] [-pxauth_type proxy_auth_type -pxuser_name proxy_user_name ]]]

Synopsis information for Openstack Swift

[-a -in instance_name -pt provider_type [-auth_id authentication_identifier | [-auth_ver authentication_version -auth_url authentication_url]]]

[-as -in instance_name -sts storage_server_name [-pxtype proxy_type -pxhost proxy_host -pxport proxy_port [-pxtunnel proxytunnel_usage] [-pxauth_type proxy_auth_type [-pxuser_name proxy_user_name]]] [-tenant_type id | name -tenant_value tenant_value -sr storage_region_name ] [-user_type id | name -user_value user_value [,user_value,user_value] [-user_domain_type id | name -user_domain_value user_domain_value] -project_type id | name -project_value project_value [-project_domain_type id | name -project_domain_value project_domain_value] -sr storage_region_name]] [-crl 0|1]

[-at api_type]

[-i [-pt provider_type | -at api_type | -in instance_name]]

[-l [-pt provider_type | -at api_type]

[-lr [-i] -in instance_name -user_name user_name -tenant_type id | name -tenant_value tenant value [-pxtype proxy_type -pxhost proxy_host -pxport proxy_port [-pxtunnel proxytunnel_usage] [-pxauth_type proxy_auth_type [-pxuser_name proxy_user_name]]] [-user_type id | name -user_value user_value [-user_domain_type id | name -user_domain_value user_domain_value] -project_type id | name -project_value project_value [-project_domain_type id | name -project_domain_value project_domain_value]]]

[-r -in instance_name]

[-rs -in instance_name -sts storage_server_name ]

[-us -in instance_name -sts storage_server_name [-ssl ssl_usage] [-crl crl_usage] [-pxtype proxy_type -pxhost proxy_host -pxport proxy_port [-pxtunnel proxytunnel_usage] [-pxauth_type proxy_auth_type -pxuser_name proxy_user_name]]

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/admincmd/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\admincmd\

DESCRIPTION

The csconfig command manages the Cloud Connect configuration settings from a remote or a local computer. The cldinstance option sets and fetches the cloud instance configuration settings.

Using this option, you can add, update, or delete only customized cloud instances and storage servers.

OPTIONS

Parameters for option -a

Use this option to add a new cloud instance.

-access_style access_style_type

Use this option to provide the endpoint access style for the cloud service provider.

Only Amazon S3 supports this option.

Valid values for -access_style_type are as follows:

  • 1 - Virtual Hosted Style

  • 2 - Path Style

    The default value for access_style_type is 2.

-auth_id authentication_identifier

Use this option to provide the identifier for the authentication URL.

Only OpenStack Swift supports this option.

-auth_url authentication_url

Use this option to provide the authentication URL provided by your cloud vendor. The authentication URL is composed of either HTTP or HTTPS and a port number.

Only OpenStack Swift supports this option.

-auth_ver authentication_version

Use this option to provide the authentication version that you want to use.

Only OpenStack Swift supports this option.

-http_port port_no

Use this option to provide the HTTP port with which you can access the cloud provider service in a non-secure mode.

Only Amazon S3 supports this option.

-https_port port_no

Use this option to provide the HTTPS port with which you can access the cloud provider service in a secure mode.

Only Amazon S3 supports this option.

-in instance_name

Use this option to provide the cloud instance name.

-pt provider_type

Use this option to provide the cloud provider type.

When you use this option to add an OpenStack Swift cloud instance, you must first determine if the Authentication Identifier, the Authentication Version, and the Authentication URL are available within NetBackup. You can list this information with the command shown:

csconfig cldprovider -i -pt provider_type

Add the cloud instance with one of the commands shown:

  • If your Provider Type lists an Authentication Version and an Authentication URL under Location Name, you can use the Authentication Identifier in this command:

    csconfig cldinstance -a -in instance_name -pt provider_type -auth_id authentication_identifier

  • If there is no Location Name section under your Provider Type, you must use the cloud vendor provided information. Use the cloud vendor provided Authentication Version value and find the corresponding value under the Credentials Broker Supported section. Use this value and the Authentication URL provided by your cloud vendor in the command shown:

    csconfig cldinstance -a -in instance_name -pt provider_type -auth_ver authentication_version -auth_url authentication_url

-se service_endpoint_path

Use this option to provide the cloud service provider endpoint.

For example, in case your cloud provider service can be accessed using the https://service.my-cloud.com/services/objectstore URL, the cloud service endpoint value is /services/objectstorage.

You can leave the value blank, if the cloud provider service can be accessed directly from the https://service.my-cloud.com URL.

Only Amazon S3 supports this option.

-sh service_host_name

Use this option to provide the cloud service provider host name.

If you want to add a public cloud instance, you need to get the service host details from the cloud storage provider.

If you want to add a cloud storage instance for a private cloud deployment, use the host name that is specified in the URL using which you can access your cloud provider. For example, if the URL is https://service.my-cloud.com/services/objectstore, the host name is service.my-cloud.com.

Do not prefix the service host name with HTTP or HTTPS.

Only Amazon S3 supports this option.

Parameters for option -ar

Only Amazon S3 supports this option.

Use this option to add a region for a specific cloud instance. When you add a region, access is restricted to the specified region.

-in instance_name

Use this option to provide the cloud instance name.

-lc location_constraint

Use this option to provide the location identifier that the cloud provider service uses to access the buckets of the associated region. For a public cloud storage, you need to get the location constraint details from the cloud provider.

-rn region_name

Use this option to provide a logical name to identify a specific region where the cloud storage is deployed.

-sh service_host

Use this option to provide the service host name for the region.

Parameters for option -as

Use this option to add a cloud storage server for the cloud instance.

-agency agency

Use this option to specify the agency name the cloud provider supplied.

Only Amazon S3 supports this option with AmazonGov Cloud.

-cert_file cert_file_name

Use this option to provide the certificate file name.

The files that are mentioned in the parameters should exist on the master server at the following location:

  • On Windows: install_path\netbackup\db\cloud

  • On UNIX: install_path/netbackup/db/cloud

Only Amazon S3 supports this option with AmazonGov Cloud.

-creds_broker creds_broker

Use this option to provide the credential broker details. The creds_broker parameter is optional.

When you do not specify the creds_broker parameter, CREDS_PROMPT is used by default and you do not need to specify the parameters following creds_broker in the given syntax.

If you want to use access key credentials, use CREDS_PROMPT. The Amazon S3 connector directly communicates with the S3 service host using the access keys.

If you want to use the CAP service as your credentials broker, use CREDS_CAP.

Only the AmazonGov Cloud supports the CREDS_CAP option.

If you want to use AWS IAM Role use CREDS_ROLE. Only Amazon S3 and AmazonGov Cloud support the CREDS_ROLE option.

The valid values for creds_broker are:

  • CREDS_PROMPT (default value).

  • CREDS_CAP

  • CREDS_ROLE

-crl

Use this option to verify if the SSL certificate must be checked for revocation before communication is established between NetBackup and cloud storage provider. This option can be enabled only if the SSL option is enabled. All cloud providers that use CA signed SSL certificates support this option. Valid values are:

  • 0 - Disables certificate revocation check

  • 1 - Enable certificate revocation check

-in instance_name

Use this option to provide the cloud instance name.

-key_file private_key_file_name

Use this option to specify the private key file name the cloud provider supplied.

The files that are mentioned in the parameters should exist on the master server at the following location:

  • On Windows: install_path\netbackup\var\global\wmc\cloud

  • On UNIX: install_path/var/global/wmc/cloud

Only Amazon S3 supports this option with AmazonGov Cloud.

-key_pass private_key_passphrase

Use this option to specify the private key pass phrase the cloud provider supplied. It must be 100 or fewer characters.

Only Amazon S3 supports this option with AmazonGov Cloud.

-lc location_constraint

Use the -lc location_constraint parameter for adding a region to a storage server. You can configure multiple regions with one storage server.

Only Amazon S3 supports this option.

Considerations for the -lc location_constraint parameter

  • NetBackup uses with the first region (authentication location) you have specified as location constraint to:

    • Verify the credentials.

    • Get the information of all the buckets.

  • Ensure that the associated cloud instance supports the region.

  • Use an empty set of double quotation marks ("") to provide a blank value.

-mission mission

Use this option to specify the mission name the cloud provider supplied.

Only Amazon S3 supports this option with AmazonGov Cloud.

-obj_size object_size

During the creation of a cloud storage server, you can specify a custom value for the object_size. Considerations for this value include the cloud storage provider, hardware, infrastructure, expected performance, and other factors.

Once you set the object_size for a cloud storage server, you cannot change the value. If you want to set a different object_size, you must recreate the cloud storage server.

-project_domain_type id | name

Use this option to specify if you want to use either the project's domain ID or domain name that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

-project_domain_value -project_domain_type_value

Use this option to provide either the project's domain ID or domain name value that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

-project_type id | name

Use this option to specify if you want to use the project ID or project name that is associated with your cloud storage credentials. When you provide the project ID, project name and domain information is not required.

Only OpenStack Swift supports this option.

-project_value project_value

Use this option to provide the project ID or project name value that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

-pxauth_type proxy_auth_type

Use this option to provide the authentication type that must be used for proxy type HTTP.

Valid values are as follows:

  • NONE (Disables authentication)

  • BASIC

  • NTLM

-pxhost proxy_host

Use this option to provide the host name and IP address of the proxy server.

-pxport proxy_port

Use this option to provide the port number of the proxy server.

-pxtunnel proxy_tunnel_usage

Use this option to specify if you want to use proxy tunneling.

Valid values are as follows:

  • 0: Disable

  • 1: Enable (Default)

Proxy tunneling is supported only for proxy type HTTP.

-pxtype proxy_type

Use this option to provide the proxy type of the proxy server.

Valid values are as follows:

  • HTTP

  • SOCKS

  • SOCKS4

  • SOCKS4A

  • SOCKS5

  • NONE (Disables the proxy type)

-pxuser_name proxy_user_name

Use this option to provide the user name of the proxy server.

-role role

Use this option to provide the role.

Only Amazon S3 supports this option.

-sr storage_region_name

Use this option to provide the cloud storage region. You may use the cloud storage region that is geographically closest to the NetBackup media server that sends the backups to the cloud. You must use the value which was derived using -lr option.

Only OpenStack Swift supports this option.

-ssl -ssl 0, -ssl 1, -ssl 2

Use this option to specify the SSL (Secure Sockets Layer) protocol for user authentication or data transfer between NetBackup and cloud storage provider.

Only Amazon S3 supports this option.

Valid values are as follows:

  • 0 - Disable SSL

  • 1 - SSL for Authentication Only

  • 2 - SSL for data transfer and authentication (Default)

-storage_tier storage_tier

Use this option to provide the storage tier for Microsoft Azure. Valid values are:

  • ACCOUNT_ACCESS_TIER (Default)

  • ARCHIVE

-sts storage_server_name

Use this option to provide the storage server name.

-tenant_type id | name

Use this option to specify if you want to use either the tenant ID or tenant name that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

-tenant_value tenant_value

Use this option to provide the tenant ID or tenant name value that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

-url service_url

Use this option to provide the service URL.

The format of the service URL is https://hostname[:port][/path].

Only Amazon S3 supports this option.

-user_domain_type id | name

Use this option to specify if you want to use either the user's domain ID or domain name that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

-user_domain_value user_domain_value

Use this option to provide either the user's domain ID or domain name value that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

-user_type id | name

Use this option to specify if you want to use either the user ID or the user name that is associated with your cloud storage credentials. When you provide user ID, user name and domain information is not required.

Only OpenStack Swift supports this option.

-user_type_value user_type_value

Use this option to provide either the user ID or the user name value that is associated with your cloud storage credentials.

Only OpenStack Swift supports this option.

Parameters for option -i

Use this option to fetch the details of all cloud instances.

-at api_type

Use this option to fetch the details of cloud instances for the specified cloud storage API type.

Valid values are:

  • s3

  • azure

  • swift

-in instance_name

Use this option to provide the cloud instance name.

-pt provider_type

Use this option to fetch the details of cloud instances for the specified cloud provider.

Parameters for option -l

Use this option to fetch the list of all cloud storage (or cloud instances) that are configured inNetBackup.

-at api_type

Use this option to fetch the details of cloud instances for the specified cloud storage API type.

Valid values are:

  • s3

  • azure

  • swift

-pt provider_type

Use this option to fetch the list of the cloud instances specific to a cloud provider.

Parameters for option -lr

Use this option to fetch a list of available storage regions.

This option is supported only for OpenStack Swift using authentication version Identity V2 and V3.

-in instance_name

Use this option to provide the cloud instance name.

-project_domain_type id | name

Use this option to specify if you want to use either the project's domain ID or domain name that is associated with your cloud storage credentials.

project_domain_value project_domain_value

Use this option to provide either the project's domain ID or domain name value that is associated with your cloud storage credentials.

-project_type id | name

Use this option to specify if you want to use either the project ID or project name that is associated with your cloud storage credentials.

When you provide project ID, project name and domain information is not required.

-project_value project_value

Use this option to provide the project ID or project name value that is associated with your cloud storage credentials.

-pxauth_type proxy_auth_type

Use this option to provide the authentication type that must be used for proxy type HTTP.

Valid values are as follows:

  • NONE (Disables authentication)

  • BASIC

  • NTLM

-pxhost proxy_host

Use this option to provide the host name or IP address of the proxy server.

-pxport proxy_port

Use this option to provide port number of the proxy server.

-pxtunnel proxy_tunnel_usage

Use this option to specify if you want to use proxy tunneling.

Valid values are as follows:

  • 0: Disable

  • 1: Enable (Default)

Proxy tunneling is supported only for proxy type HTTP.

-pxtype proxy_type

Use this option to provide the proxy type of the proxy server.

Valid values are as follows:

  • HTTP

  • SOCKS

  • SOCKS4

  • SOCKS4A

  • SOCKS5

  • NONE (Disables the proxy type)

-pxuser_name proxy_user_name

Use this option to provide user name of the proxy server.

-tenant_type id | name

Use this option to provide the tenant ID or tenant name that is associated with your cloud storage credentials.

-tenant_value tenant_value

Use this option to provide the tenant ID or tenant name value that is associated with your cloud storage credentials.

-user_domain_type id | name

Use this option to specify if you want to use either the user's domain ID or domain name that is associated with your cloud storage credentials.

-user_domain_value user_domain_value

Use this option to provide either the user's domain ID or domain name value that is associated with your cloud storage credentials.

-user_name user_name

Use this option to provide the cloud storage user name.

-user_type id | name

Use this option to specify if you want to use either the user ID or the user name that is associated with your cloud storage credentials.

When you provide user ID, user name and domain information is not required.

-user_type_value user_type_value

Use this option to provide either the user ID or the user name value that is associated with your cloud storage credentials.

Parameters for option -r

Use this option to remove a cloud instance.

-in instance_name

Use this option to provide the cloud instance name.

Parameters for option -rr

Use this option to remove a region association for a specific cloud instance.

Only Amazon S3 supports this option.

-in instance_name

Use this option to provide the cloud instance name.

-lc location_constraint

Use this option to provide the location identifier that the cloud provider service uses to access the buckets of the associated region.

For a public cloud storage, you need to get the location constraint details from the cloud provider.

Parameters for option -rs

Use this option to remove the cloud storage server for specified cloud instance.

-in instance_name

Use this option to provide the cloud instance name.

-sts storage_server_name

Use this option to provide the storage server name.

Parameters for option -u

Use this option to update an existing cloud instance.

Only Amazon S3 supports this option.

-access_style access_style_type

Use this option to provide the endpoint access style for the cloud service provider.

Valid values for -access_style_type are as follows:

  • 1 - Virtual Hosted Style

  • 2 - Path Style

    The default value for access_style_type is 2.

-http_port port_no

Use this option to provide the HTTP port with which you can access the cloud provider service in a non-secure mode.

-https_port port_no

Use this option to provide the HTTPS port with which you can access the cloud provider service in a secure mode.

-in instance_name

Use this option to provide the cloud instance name.

-se service_endpoint_path

Use this option to provide the cloud service provider endpoint.

-sh service_host_name

Use this option to provide the cloud service provider host name.

Parameters for option -ur

Use this option to update a region for a specific cloud instance.

Only Amazon S3 supports this option.

-in instance_name

Use this option to provide the cloud instance name.

-lc location_constraint

Use this option to provide the location identifier that the cloud provider service uses for any data transfer operations in the associated region. For a public cloud storage, you need to get the location constraint details from the cloud provider.

-rn region_name

Use this option to provide the cloud storage region.

-sh service_host

Use this option to provide the cloud service provider host name.

Parameters for option -us

Use this option to update the storage server for the specified cloud instance.

-agency agency

Use this option to specify the agency name the cloud provider supplied.

Only Amazon S3 supports this option with AmazonGov Cloud.

-auth_lc authentication_location_constraint

Use this option to provide the authentication location constraint to update the cloud storage server's authentication location.

Only Amazon S3 supports this option.

-cert_file cert_file_name

Use this option to provide the certificate file name.

The files that are mentioned in the parameters should exist on the master server at the following location:

  • On Windows: install_path\netbackup\var\global\wmc\cloud

  • On UNIX: install_path/var/global/wmc/cloud

Only Amazon S3 supports this option with AmazonGov Cloud.

-del_lc location_constraint

Use this option to provide the location constraint to delete a region from the storage server.

Only Amazon S3 supports this option.

-in instance_name

Use this option to provide the cloud instance name.

-key_file private_key_file_name

Use this option to specify the private key file name the cloud provider supplied.

The files that are mentioned in the parameters should exist on the master server at the following location:

  • On Windows: install_path\netbackup\var\global\wmc\cloud

  • On UNIX: install_path/var/global/wmc/cloud

Only Amazon S3 supports this option with AmazonGov Cloud.

-key_pass private_key_passphrase

Use this option to specify the private key file name the cloud provider supplied. It must be 100 or fewer characters.

Only Amazon S3 supports this option with AmazonGov Cloud.

-lc location_constraint

Use this option to provide the location constraint to update the storage server to add a new region.

Only Amazon S3 supports this option.

-mission mission1

Use this option to specify the mission name the cloud provider supplied.

Only Amazon S3 supports this option with AmazonGov Cloud.

-pxauth_type proxy_auth_type

Use this option to provide the authentication type that must be used for proxy type HTTP.

Valid values are as follows:

  • NONE (Disables authentication)

  • BASIC

  • NTLM

-pxhost proxy_host

Use this option to provide the host name or IP address of the proxy server.

-pxport proxy_port

Use this option to provide the port number of the proxy server.

-pxuser_name proxy_user_name

Use this option to provide the proxy server user name.

-pxtype proxy_type

Use this option to provide the proxy type of the proxy server.

Valid values are as follows:

  • HTTP

  • SOCKS

  • SOCKS4

  • SOCKS4A

  • SOCKS5

  • NONE (Disables the proxy type)

-pxtunnel proxytunnel_usage

Use this option to specify if you want to use proxy tunneling.

Valid values are as follows:

  • 0: Disable

  • 1: Enable (Default)

Proxy tunneling is supported only for proxy type HTTP.

-role role

Use this option to provide the role.

Only Amazon S3 supports this option with AmazonGov Cloud.

-url service_url

Use this option to provide the service url.

The format of the service URL is https://hostname[:port][/path].

Only Amazon S3 supports this option.

EXAMPLES

Example 1: Add cloud instance of type Hitachi with custom ports for HTTP and HTTPS.

csconfig cldinstance -a -in my-hitachi.com -pt hitachi 
-sh my-hitachi.com -http_port 80 -https_port 443 -access_style 2

Example 2: Update cloud instance my-hitachi.com of type Hitachi with new Service Host (s3.finance-hitachi.com).

csconfig cldinstance -u -in my-hitachi.com -sh s3.finance-hitachi.com 
-se s3.hitachi.com -http_port 80 -https_port 443 -access_style 2

Example 3: Add storage server for Amazon S3 with proxy type HTTP and authentication type as basic and proxy tunneling disabled.

csconfig cldinstance -as -in my-hitachi.com -sts abc-hitachi.com 
-pxtype HTTP -pxhost Hostname.DomainName.com -pxport 527 
-pxauth_type BASIC -pxtunnel 1 -pxuser_name test  
-lc us-east-1,us-west-2

Note:

This command prompts for the password.

Example 4: Add storage server for an existing AmazonGov Cloud instance with Credentials Broker supported.

csconfig cldinstance -as -in my-amzgov.com -sts abc-amzgov.com 
-creds_broker CREDS_CAP -url https://my.host.com:8080/service-path 
-mission dummy_mission -agency dummy_agency -role dummy_role 
-cert_file dummy_file -key_file dummy_key_file 
-key_pass dummy_passphrase

Example 5: Update storage servers for existing AmazonGov Commercial Cloud Services instance with Credentials Broker supported.

csconfig cldinstance -us -in my-amzgov.com -sts abc-amzgov.com 
-url https://my.host.com:8080/service-path -mission dummy_mission 
-agency dummy_agency -role dummy_role -cert_file dummy_file 
-key_file dummy_key_file key_pass dummy_passphrase

Note:

You can update one or many parameters of a storage server at the same time.

Example 6: Add OpenStack Swift cloud instance for authentication version Identity V2.

csconfig cldinstance -a -in my-swiftstack.com -pt swstksw
-auth_ver IDENTITY_V2 -auth_url
https://lon.identity.api.swiftstack.com/v2.0/tokens

Example 7: List the storage regions for an OpenStack Swift-compliant cloud provider. This command is applicable only for authentication version Identity V2.

csconfig cldinstance -lr -in my-swiftstack.com -user_name John
-tenant_type id -tenant_value 1234

Example 8: Add storage server for an existing OpenStack Swift instance.

csconfig cldinstance -as -in my-swiftstack.com -sts abc-swiftstack.com
-tenant_type id -tenant_value 1234 -sr RegionUS

Example 9: Add storage server for an existing cloud instance for a OpenStack Swift-compliant cloud using the user ID and project name. When you provide the User ID, Domain Type and Value parameters are not required. This command is applicable only for authentication version Identity V3.

csconfig cldinstance -as -in swiftstack_v3 -sts swiftstack
-user_type id -user_value user_id123 -project_type name
-project_value project_name123 -project_domain_type id
-project_domain_value domain_id123 -sr region_name

Example 10: Add storage server for an existing cloud instance for a OpenStack Swift-compliant cloud using the user name and project ID. When you provide Project ID, Domain Type and Value parameters are not required. This command is applicable only for authentication version Identity V3.

csconfig cldinstance -as -in swiftstack_v3 -sts swiftstack
-user_type name -user_value user_name123 -user_domain_type name
-user_domain_value domain_name123 -project_type id
-project_value project_id123 -sr region_name

Example 11: List the storage regions of an existing cloud instance (Identity V3) for a OpenStack Swift-compliant cloud using the user ID and project name.

csconfig cldinstance -lr -in swiftstack_v3
-user_type id -user_value user_id123
-project_type name -project_value project_name123
-project_domain_type id -project_domain_value domain_id123

Example 12. List the storage regions of an existing cloud instance (Identity V3) for a OpenStack Swift-compliant cloud using the user name and project ID.

csconfig cldinstance -lr -in swiftstack_v3
-user_type name -user_value user_name123
-user_domain_type name -user_domain_value domain_name123
-project_type id -project_value project_id123

Example 13: Add storage server for existing cloud instance with location constraint.

csconfig cldinstance -as -in amazon.com  -sts myamz-us.com 
-lc us-east-1,us-west-2

Example 14: Add region for a cloud instance.

csconfig cldinstance -ar -in myamazon.com -lc us-west-1 
-rn "US West (N. California)" -sh s3-us-west 1.amazonaws.com