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
nbkmscmd — configure le service de gestion des clés (KMS) dans NetBackup.
Synopsis
-configureCredential -credName credential_name -certPath certificate_file_path -privateKeyPath private_key_file_path -trustStorePath CA_certificate_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-server master_server_name] [-description description] [-force]
To configure NetBackup KMS (NBKMS):
-configureKMS -name configuration_name -type NBKMS -hmkId host_master_key_ID_to_identify_HMK_passphrase -kpkId key_protection_key_ID_to_identify_KPK_passphrase [-useRandomPassphrase 0 | 1] [-enabledForBackup 0 | 1] [-priority priority_of_KMS_server] [-server master_server_name] [-description description]
To configure external KMS:
-configureKMS -name configuration_name -type KMIP -port port_to_connect_to_external_KMS_server -kmsServerName network_name_of_external_KMS_server -credId credential_ID | -credName credential_name [-enabledForBackup 0 | 1] [-priority priority_of_KMS_server] [-server master_server_name] [-description description]
-createKey -name configuration_name -keyName name_of_the_key_to _be_created -keyGroupName key_group_name [-algorithm key_algorithm] [-comment comment_about_the_key] [-keyPassphraseFilePath file_path_of_the_key_passphrase] [-reason reason][-server master_server_name]
-deleteCredential -credName credential_name | -credId credential_ID [-force] [-server master_server_name]
-deleteKMSConfig -name configuration_name [-server master_server_name] [-reason reason_for_deleting] [-force]
-discoverNBKMS
-listCredential [-credName credential_name | -credId credential_ID] [-server master_server_name] [-jsonCompact] [-jsonRaw] [-pageLimit number_of_records_to_be_listed after_offset] [-pageOffset record_number]
-listKeys -name configuration_name [-keyGroupName key_group_name] [-server master_server_name] [-jsonCompact] [-jsonRaw] [-pageLimit number_of_records_to_be_listed_after_offset] [-pageOffset record_number]
-listKMSConfig [-name configuration_name] [-server master_server_name] [-jsonCompact] [-jsonRaw] [-pageLimit number_of_records_to_be_listed_after_offset] [-pageOffset record_number]
-precheckKMSConfig -port port_to_connect_to_external_KMS_server -kmsServerName network_name_of_external_KMS_server -certPath certificate_file_path -privateKeyPath private_key_file_path -trustStorePath CA_certificate_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-credId credential_ID | -credName credential_name] [-server master_server_name] [-jsonRaw]
-updateCredential -credId credential_ID | -credName credential_name -certPath certificate_file_path -privateKeyPath private_key_file_path -trustStorePath CA_certificate_file_path [-passphrasePath private_key_passphrase_file_path] [-crlCheckLevel LEAF | CHAIN | DISABLE] [-server master_server_name] [-description description] [-force]
To update NetBackup KMS (NBKMS) configuration:
-updateKMSConfig -name configuration_name [-server master_server_name] [-priority priority_of_KMS_server] [-enabledForBackup 0 | 1] [-description description]
To update external KMS configuration:
-updateKMSConfig -name configuration_name [-server master_server_name] [-priority priority_of_KMS_server] [-port port_to_connect_to_external_KMS_server] [-kmsServerName network_name_of_external_KMS_server] [-credId credential_ID | -credName credential_name] [-enabledForBackup 0 | 1] [-description description]
-validateKMSConfig -name configuration_name [-server master_server_name] [-jsonRaw]
On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/
On Windows systems, the directory path to this command is install_path\NetBackup\bin\
DESCRIPTION
Exécutez la commande nbkmscmd pour configurer le KMS. Vous pouvez également créer des informations d'authentification KMS et des clés. Toutes ces commandes requièrent le privilège d'administration de NetBackup. En outre, ces opérations nécessitent une connexion Web bpnbat (bpnbat -login -loginType WEB) à l'aide d'un compte possédant des droits d'administrateur NetBackup.
La commande nbkmscmd prend en charge les opérations suivantes :
|
-configureCredential |
Ajoute les informations d'authentification de la configuration KMS dans la base de données NetBackup. L'ID des informations d'authentification et le nom correspondant sont ajoutés dans la base de données. Ces informations d'authentification sont utilisées pour se connecter au service de gestion des clés (KMS) externe. |
|
-configureKMS |
Ajoute une entrée pour la configuration KMS dans la base de données NetBackup. |
|
-createKey |
Crée une clé NetBackup active sur le serveur KMS qui est associé au nom de configuration fourni. Pour créer la clé, le serveur KMS doit autoriser NetBackup à créer la clé et à définir les attributs NetBackup sur cette clé. Pour le service de gestion des clés de NetBackup (NBKMS), si le nom du groupe de clés n'existe pas, le groupe de clés est créé avec l'algorithme spécifié. |
|
-deleteCredential |
Supprime les informations d'authentification spécifiées de la configuration KMS de la base de données NetBackup. |
|
-deleteKMSConfig |
Supprime l'entrée de configuration KMS de la base de données NetBackup. |
|
-discoverNBKMS |
Permet de découvrir si le service de gestion des clés NetBackup (NBKMS) est configuré et en cours d'exécution, et l'ajoute à la base de données NetBackup. |
|
-listCredential |
Affiche les détails des informations d'authentification de la configuration KMS spécifiée au format JSON. Si le nom ou l'ID des informations d'authentification n'est pas fourni, les détails des informations d'authentification de l'ensemble des configurations KMS s'affichent. |
|
-listKeys |
Affiche la liste des clés NetBackup de la configuration KMS spécifiée au format JSON. |
|
-listKMSConfig |
Affiche les détails de la configuration KMS spécifiée au format JSON. Si le nom de la configuration n'est pas fourni, cette opération affiche la liste des détails de configuration de tous les services de gestion des clés (KMS). |
|
-precheckKMSConfig |
Exécute à vide les opérations de configuration KMS pour valider les connexions requises et l'installation. |
|
-updateCredential |
Met à jour les informations d'authentification de la configuration KMS spécifiée. |
|
-updateKMSConfig |
Met à jour la configuration KMS spécifiée dans la base de données NetBackup. |
|
-validateKMSConfig |
Valide la fonctionnalité avec la configuration KMS spécifiée et vérifie que la fonctionnalité de sauvegarde et de restauration fonctionne. |
OPTIONS
- -algorithm algorithme
Spécifie l'algorithme de chiffrement de la clé qui a été créée.
- -certPath chemin_fichier_certificat
Spécifie le chemin du certificat utilisé pour se connecter au serveur distant.
- -comment commentaire
Spécifie un commentaire sur la clé.
- -credId ID_informations_authentification
Spécifie l'ID des informations d'authentification de la configuration KMS.
- -credName nom_informations_authentification
Spécifie le nom des informations d'authentification de la configuration KMS.
- -crlCheckLevel LEAF | CHAIN | DISABLE
Spécifie le niveau de contrôle de révocation pour les certificats du serveur KMS externe. La valeur par défaut est LEAF.
Valeurs acceptées pour le niveau de vérification de la liste de révocation des certificats :
DISABLE : le contrôle de révocation est désactivé. L'état de révocation du certificat n'est pas validé par rapport à la liste de révocation des certifications pendant la communication avec l'hôte.
LEAF : l'état de révocation du certificat feuille est validé par rapport à la liste de révocation des certificats.
CHAIN : l'état de révocation de tous les certificats de la chaîne de certificats est validé à l'aide de la liste de révocation des certifications.
- -description description
Permet d'apporter des informations supplémentaires sur l'opération en cours.
- -enabledForBackup 0 | 1
Spécifie si les clés provenant de ce KMS doivent être utilisées pour la sauvegarde ou non. La valeur par défaut est de 1.
Indiquez 0 si les clés de ce KMS ne doivent pas être utilisées pour la sauvegarde.
- -force
Supprime les invites de confirmation et exécute l'opération spécifiée.
- -hmkId ID_clé_maître_hôte_pour_identifier_phrase_passe_HMK
Spécifie l'ID de clé HMK servant à identifier la phrase de passe HMK. Cette option s'applique uniquement si le type KMS est NBKMS.
- -jsonCompact
Génère des données de sortie dans un format JSON compacté.
- -jsonRaw
Affiche la réponse JSON du serveur web.
- -keyGroupName nom_groupe_clés
Spécifie le nom du groupe de clés qui est utilisé pour récupérer ou définir des clés.
- -keyName nom_clé
Spécifie le nom de la clé.
- -keyPassphraseFilePath chemin_fichier_de_la_phrase_passe_de_la_clé
Spécifie le chemin d'accès au fichier de la phrase de passe utilisée pour créer la clé. Seuls certains types KMS prennent en charge les phrases de passe de la clé.
- -kmsServerName nom_réseau_du_serveur_KMS_externe
Spécifie le nom de réseau du serveur KMS. S'il y a plusieurs noms de réseau pour le serveur KMS, séparez-les par une virgule (,). Cette option s'applique uniquement si le type KMS est KMIP.
- -kpkId ID__clé_protection_pour_identifier_phrase_passe_KPK
Spécifie l'ID de clé de protection de clés (KPK) servant à identifier la phrase de passe KPK. Cette option s'applique uniquement si le type KMS est NBKMS.
- -name nom_configuration
Spécifie un nom unique pour la configuration KMS.
- -pageLimit nombre_enregistrements_à_répertorier_après_décalage
Spécifie le nombre d'enregistrements à inclure dans la liste après le décalage. Les valeurs valides pour -pageLimit vont de 1 à 100. La valeur par défaut est de 100.
- -pageOffset numéro_enregistrement
Spécifie le numéro d'enregistrement à partir duquel les enregistrement sont répertoriés. La valeur par défaut est 0.
- -passphrasePath chemin_fichier_phrase_passe_clé_privée
Spécifie le chemin d'accès au fichier de la phrase de passe utilisée pour chiffrer la clé privée du certificat.
- -port port_pour_connecter_au_serveur_KMS_externe
Spécifie le numéro de port à utiliser pour se connecter au serveur KMS externe. Cette option s'applique uniquement si le type KMS est KMIP.
- -priority priorité_du_serveur_KMS
Spécifie le serveur KMS à utiliser lorsque NetBackup recherche des clés pendant le chiffrement ou le déchiffrement. Par défaut, la priorité du serveur KMS est définie sur 0. Le serveur KMS ayant la valeur la plus élevée devient prioritaire lors du chiffrement ou déchiffrement.
- -privateKeyPath chemin_fichier_clé_privée
Spécifie le chemin d'accès au fichier de la clé privée du certificat.
- -reason raison
Spécifie la raison pour laquelle l'opération en cours s'exécute.
- -server master_server_name
Spécifie un autre serveur maître. Par défaut, cette commande utilise la première entrée de serveur dans le fichier de configuration de NetBackup.
- -trustStorePath chemin_fichier_certificat_autorité_certification
Spécifie le chemin d'accès au fichier du certificat d'autorité de certification utilisé pour vérifier le serveur distant.
- -type NBKMS | KMIP
Spécifie le type KMS. NBKMS et KMIP constituent les types KMS valides.
- -useRandomPassphrase 0|1
Spécifie si des phrases de passe aléatoires doivent être utilisées ou non. La valeur par défaut est de 0. Fournissez 1 si des phrases de passe aléatoires doivent être utilisées pour la configuration KMS.
EXEMPLES
Exemple 1 : configurer les informations d'authentification pour le serveur KMS externe
nbkmscmd -configureCredential -credName ExtKMS_Credential -certPath /EKMS_creds/cert_chain.pem -privateKeyPath /EKMS_creds/key.pem -trustStorePath /EKMS_creds/cacerts.pem -description "Configuring credential for external KMS"
Exemple 2 : configurer un serveur KMS externe.
nbkmscmd -configureKMS -name ExtKMS -type KMIP -kmsServerName extkms.veritas.com -port 5696 -credName ExtKMS_Credential -priority 1 -description "Configuring external KMS with configutation name ExtKMS"