NetBackup™ Commands Reference Guide
- Introduction
- Annexe A. NetBackup Commands
- acsd
- backupdbtrace
- backuptrace
- bmrc
- bmrconfig
- bmrepadm
- bmrprep
- bmrs
- bmrsrtadm
- bp
- bparchive
- bpbackup
- bpbackupdb
- bpcatarc
- bpcatlist
- bpcatres
- bpcatrm
- bpcd
- bpchangeprimary
- bpcleanrestore
- bpclient
- bpclimagelist
- bpclntcmd
- bpclusterutil
- bpcompatd
- bpconfig
- bpdbjobs
- bpdbm
- bpdgclone
- bpdown
- bpduplicate
- bperror
- bpexpdate
- bpfis
- bpflist
- bpgetconfig
- bpgetdebuglog
- bpimage
- bpimagelist
- bpimmedia
- bpimport
- bpinst
- bpkeyfile
- bpkeyutil
- bplabel
- bplist
- bpmedia
- bpmedialist
- bpminlicense
- bpnbat
- bpnbaz
- bppficorr
- bpplcatdrinfo
- bpplclients
- bppldelete
- bpplinclude
- bpplinfo
- bppllist
- bpplsched
- bpplschedrep
- bpplschedwin
- bppolicynew
- bpps
- bprd
- bprecover
- bprestore
- bpretlevel
- bpschedule
- bpschedulerep
- bpsetconfig
- bpstsinfo
- bpstuadd
- bpstudel
- bpstulist
- bpsturep
- bptestbpcd
- bptestnetconn
- bpup
- bpverify
- cat_convert
- cat_export
- cat_import
- configureCerts
- configureMQ
- configureWebServerCerts
- create_nbdb
- csconfig cldinstance
- csconfig cldprovider
- csconfig meter
- csconfig reinitialize
- csconfig throttle
- duplicatetrace
- importtrace
- jbpSA
- jnbSA
- ltid
- mklogdir
- msdpcldutil
- nbauditreport
- nbcallhomeproxyconfig
- nbcatsync
- NBCC
- NBCCR
- nbcertcmd
- nbcertupdater
- nbcldutil
- nbcmdrun
- nbcomponentupdate
- nbcplogs
- nbcredkeyutil
- nbdb_admin
- nbdb_backup
- nbdb_move
- nbdb_ping
- nbdb_backup
- nbdb_move
- nbdb2adutl
- nbdb_restore
- nbdbms_start_stop
- nbdc
- nbdecommission
- nbdelete
- nbdeployutil
- nbdevconfig
- nbdevquery
- nbdiscover
- nbdna
- nbemm
- nbemmcmd
- nbepicfile
- nbfindfile
- nbfirescan
- nbfp
- nbftadm
- nbftconfig
- nbgetconfig
- nbhba
- nbholdutil
- nbhostidentity
- nbhostmgmt
- nbhypervtool
- nbidpcmd
- nbimageshare
- nbinstallcmd
- nbjm
- nbkmiputil
- nbkmscmd
- nbkmsutil
- nboraadm
- nborair
- nboracmd
- nbpem
- nbpemreq
- nbmariadb
- nbmlb
- nbperfchk
- nbplupgrade
- nbrb
- nbrbutil
- nbreplicate
- nbrepo
- nbrestorevm
- nbseccmd
- nbserviceusercmd
- nbsetconfig
- nbshvault
- nbsmartdiag
- nbsnapimport
- nbsnapreplicate
- nbsqladm
- nbsqlite
- nbstl
- nbstlutil
- nbstop
- nbsu
- nbsvrgrp
- netbackup_deployment_insights
- resilient_clients
- restoretrace
- stopltid
- tldd
- tldcd
- tpautoconf
- tpclean
- tpconfig
- tpext
- tpreq
- tpunmount
- verifytrace
- vltadm
- vltcontainers
- vlteject
- vltinject
- vltoffsitemedia
- vltopmenu
- vltrun
- vmadd
- vmchange
- vmcheckxxx
- vmd
- vmdelete
- vmoprcmd
- vmphyinv
- vmpool
- vmquery
- vmrule
- vmupdate
- vnetd
- vssat
- vwcp_manage
- vxlogcfg
- vxlogmgr
- vxlogview
- W2KOption
Nom
nbkmiputil — exécute les différentes opérations du serveur KMS externe.
Synopsis
-getKey -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path -keyId key_ID [-kadLength KAD_length] | -nbKeyGroup key_group_name [-kadLength KAD_length] | -kad key_associated_data [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-getDetails] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-jsonCompact]
-listKeyIDs -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path [-nbKeyGroup key_group_name] [-activeKey] [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-getDetails] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-maxItems number] [-offset number] [-jsonCompact]
-setAttribute -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path -keyId key_ID -attributeName attribute_name -attributeValue attribute_value [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-jsonCompact]
-validate -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-connectTimeout time_in_seconds] [-requestTimeout time_in_seconds] [-kmipVersion version] [-jsonCompact]
-ekmsCheckCompat | -ecc -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-kmipVersion version] [-jsonCompact] [-extended] [-verbose]
-setState -kmsServer kms_server_name -port kms_server_port -trustStorePath CA_certificate_file_path -certPath certificate_file_path -privateKeyPath private_key_file_path -keyId key_ID -stateType 1 | 2 | 3 | 4 [-revocationReason 1 | 2 | 3 | 4 | 5 | 6 | 7] [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-connectTimeout time_in_seconds] [-requestTimeout seconds] [-kmipVersion version] [-jsonCompact]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/goodies/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\goodies\
DESCRIPTION
La commande nbkmiputil exécute les différentes opérations du serveur KMS externe, telles que la récupération des clés, la génération de la liste des ID de clé, la définition des attributs de clé, la définition de l'état des clés et la validation des serveurs KMS.
Cette commande prend en charge les opérations suivantes :
|
-ekmsCheckCompat ou -ecc |
Utilisez -ekmsCheckCompat ou -ecc pour déterminer si NetBackup est compatible avec le serveur KMS externe spécifié. Vous pouvez également utiliser cette option pour déterminer si les opérations KMIP suivantes sont prises en charge sur le serveur KMS externe : création de clés et récupération de clés par groupe de clés et par ID de clé. |
|
-getKey |
Récupère les clés NetBackup auprès du serveur KMS externe. |
|
-listKeyIDs |
Donne la liste des ID de clés NetBackup présentes sur le serveur KMS externe selon les options spécifiées. |
|
-setAttribute |
Définit l'attribut personnalisé de la clé spécifique sur le serveur KMS externe. Les noms d'attribut x-application, x-keygroup et x-comment sont pris en charge. |
|
-setState |
Définit l'état de la clé spécifiée sur le serveur KMS externe. |
|
-validate |
Valide la fonctionnalité associée auprès du serveur KMS externe. La fonctionnalité qui est validée inclut :
|
OPTIONS
- -activeKey
Indique s'il faut uniquement donner la liste des clés NetBackup actives.
- -attributeName
Spécifie le nom d'attribut personnalisé à définir. Les noms d'attribut pris en charge sont x-application, x-keygroup et x-comment.
- -attributeValue
Spécifie la valeur d'attribut personnalisé à définir. Valeur prise en charge pour l'attribut x-application : NetBackup.
- -certPath
Spécifie le chemin du certificat codé au format PEM à utiliser pour l'authentification sur le serveur KMS externe.
- -connectTimeout
Spécifie la valeur de temporisation, exprimée en secondes, à utiliser pour se connecter au serveur KMS externe. La valeur par défaut est de 120 secondes.
- -crlCheckLevel
Spécifie le niveau de vérification de la liste de révocation des certificats. Les valeurs possibles sont les suivantes : LEAF, CHAIN et DISABLE. La valeur par défaut est LEAF.
LEAF : vérifie le statut de révocation du certificat feuille du pair.
CHAIN : vérifie le statut de révocation de la chaîne complète de certificats de pair.
DISABLE : l'état de révocation du certificat de pair n'est pas vérifié.
- -extended
Effectue des opérations telles que la recherche de clés, l'obtention d'attributs et la définition d'attributs en plus de la création et de la récupération de clés par groupe de clés et par ID de clé.
- -getDetails
Affiche les détails supplémentaires des attributs des clés NetBackup.
- -jsonCompact
Spécifie si la sortie doit s'afficher sous forme compacte JSON.
- -kad
Spécifie les données associées à la clé (KAD) de la clé NetBackup à récupérer sur le serveur KMS externe.
- -kadLength
Spécifie la longueur jusqu'à laquelle un KAD de clé NetBackup doit être généré.
- -keyId
Si -keyId est utilisé avec l'option -getKey, il spécifie l'ID de clé de la clé NetBackup à récupérer du serveur KMS externe. S'il est utilisé avec l'option -setAttribute, il spécifie l'ID de la clé pour laquelle un attribut personnalisé doit être défini.
- -kmsServer
Spécifie le nom du serveur KMS externe auquel vous souhaitez vous connecter.
- -kmipVersion version
Spécifie la version KMIP à utiliser. Versions KMIP prises en charge : 1.0, 1.1, 1.2, 1.3, 1.4 et 2.0.
- -maxItems
Spécifie le nombre maximal d'ID de clé à inclure dans la liste.
- -nbKeyGroup
Si cette option est utilisée avec l'option -getKey, elle spécifie le nom du groupe de clés dont la clé active et la plus récente doit être récupérée à partir du serveur KMS externe. Si elle est utilisée avec l'option -listKeyIDs, elle spécifie le nom du groupe de clés pour lequel il faut créer une liste de clés.
- -offset
Spécifie le numéro de décalage de l'ID de clé à partir duquel la liste des ID de clés doit commencer. La valeur par défaut est de 0.
- -passphrasePath
Spécifie le chemin du fichier contenant la phrase de passe requise pour accéder au magasin de clés et procéder à l'authentification sur le serveur KMS externe.
- -port
Le numéro de port utilisé par le serveur KMS externe.
- -privateKeyPath
Spécifie le chemin de la clé privée à utiliser pour l'authentification sur le serveur KMS externe.
- -requestTimeout
Spécifie la valeur de temporisation, exprimée en secondes, à utiliser pour la requête donnée sur le serveur KMS externe. La valeur par défaut est 300 secondes.
- -revocationReason 1 | 2 | 3| 4 | 5 | 6 | 7
Motifs de révocation de clés pris en charge :
Pour -stateType DEACTIVATED :
1 | UNSPECIFIED : le motif de la révocation de la clé n'est pas spécifié.
2 | AFFILIATION_CHANGED : l'affiliation du propriétaire de la clé au sein de l'organisation a changé.
3 | SUPERSEDED : la clé actuelle doit être remplacée par la nouvelle clé émise.
4 | CESSATION_OF_OPERATION : la clé n'est plus requise, car l'opération ou le service associé a été abandonné.
5 | PRIVILEGE_WITHDRAWN : les privilèges associés à la clé ont été retirés.
Pour -stateType COMPROMISED :
6 | KEY_COMPROMISE : la clé est compromise.
7 | CA_COMPROMISE : l'autorité de certification qui a émis le certificat pour le serveur KMS externe est compromise.
- -stateType 1 | 2 | 3 | 4
Types d'états pris en charge :
1 | ACTIVE : vous pouvez utiliser cette clé à des fins de chiffrement.
2 | DEACTIVATED : la clé doit être utilisée uniquement pour traiter des informations de chiffrement
3 | COMPROMISED : la clé doit être utilisée uniquement pour traiter des informations de chiffrement sur un client approuvé utilisant des clés gérées compromises.
4 | DESTROYED : la clé ne doit pas être utilisée pour traiter des informations de chiffrement.
- -trustStorePath
Spécifie le chemin du certificat de l'autorité de certification codé au format PEM à utiliser pour l'authentification sur le serveur KMS externe.
- -verbose
Indique si une sortie détaillée au format JSON doit être affichée.
EXEMPLES
Exemple 1 : définir les attributs personnalisés du serveur KMS externe.
nbkmiputil -setAttribute -kmsServer example.veritas.com -port 5696 -certPath /usr/cert.pem -privateKeyPath /usr/key.pem -trustStorePath /usr/ca.pem -keyId EFF18E49-DBBF-4F84-BF94-13F4A6B6E32B -attributeName x-keygroup -attributeValue msdp