Cette rubrique concerne toutes les commandes et les arguments pour gérer PSHubContext.
Vous devrez avoir installé le module Devolutions.PowerShell pour utiliser ces commandes.
Des permissions appropriées sont également nécessaires pour exécuter certaines de ces commandes. Veuillez vous référer à Utilisateurs d'application.
PSHubContext est un objet qui spécifie vos informations d'authentification. Vous aurez besoin d'un PSHubContext valide pour vous connecter à votre Devolutions Hub Business. Vous pouvez avoir plusieurs PSHubContext connectés dans votre session PowerShell, mais un seul est utilisé lorsque vous utilisez l'applet de commande Devolutions Hub.
Dans cet objet, vous avez ce qui suit :
- Nom : Nom de l'utilisateur d'application
- URL : URL du Devolutions Hub Business
- Clé secrète d'application : Clé secrète d'application donnée après la création de l'utilisateur d'application
- Clé de l'application : Clé de l'application donnée après la création de l'utilisateur d'application
- Pour vérifier toutes les commandes disponibles :
Get-Command-Module <ModuleName>
- Pour vérifier tous les arguments et paramètres potentiels pour une commande :
Show-Command <CommandName>
Connexion
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
Connect-HubAccount |
|
Si PSHubContext est fourni, tente de se connecter à Devolutions Hub avec celui-ci.
ou Si PSHubContext n'est pas fourni, crée un PSHubContext avec les informations reçues et tente de se connecter à Devolutions Hub par la suite. |
$PSHubContext = [Devolutions.Hub.PowerShell.Entities.PowerShell.PSHubContext]@{ApplicationKey="24526a88-7f18-4356-95bd-11690f7bc59b;468ce2d5-ea4b-42ff-bc02-d93c71b4e554"; ApplicationSecret="U4nmdOjqPAcL0GfbvNC2u8e0FCZjhEJFTnn6YHpIZDY="; Url="https://<YourPasswordHubUrl>.devolutions.app"}
ou
|
Disconnect-HubAccount |
|
Si ApplicationKey est fourni, déconnecte et supprime PSHubContext de la session PowerShell.
ou Si All est fourni, déconnecte et supprime tous les PSHubContext de la session PowerShell. |
Contexte
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
Get-HubContext |
|
Si ListAvailable est fourni, répertorie tous les PSHubContext définis dans la session PowerShell. Si ListAvailable n'est pas fourni, récupère le PSHubContext actuel qui sera utilisé pour toutes les autres commandes Devolutions Hub. |
|
Set-HubContext |
|
Définir le PSHubContext actuel sur celui fourni. | |
Select-HubContext |
|
Sélectionner un autre PSHubContext pour modifier le PSHubContext actuel qui sera utilisé pour toutes les commandes Devolutions Hub. | |
Save-HubContext |
|
Enregistrer le PSHubContext actuel dans un fichier .json par le chemin d'accès reçu. Si PSHubContext est fourni, enregistre celui-ci dans un fichier .sjon. Si Force est fourni, écrase le fichier si le chemin d'accès existe déjà. Si SecurePassword est fourni, invite l'utilisateur à entrer un mot de passe pour chiffrer le fichier .json. ou Si Password est fourni, chiffre le fichier .json avec le mot de passe reçu. |
Enregistrer un PSHubContext standard.
Si vous souhaitez enregistrer en toute sécurité un PSHubContext avec un mot de passe, vous pouvez le faire de 2 manières : Avec un mot de passe envoyé par argument.
ou Avec l'argument SecurePassword, qui demandera la saisie du mot de passe sécurisé.
|
Import-HubContext |
|
Importer un PSHubContext à partir d'un fichier .json par le chemin d'accès reçu.
Si SecurePassword est fourni, invite à entrer un mot de passe pour déchiffrer le fichier .json. Si Password est fourni, déchiffre le fichier .json avec le mot de passe reçu. |
Importer un PSHubContext standard.
Si vous souhaitez importer un fichier protégé par mot de passe, vous pouvez le faire de 2 manières : Avec un mot de passe envoyé par argument.
ou Avec l'argument SecurePassword, qui demandera la saisie du mot de passe sécurisé.
|
Paramètres système
Cette section concerne les commandes permettant de gérer les paramètres système.
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
Get-HubSystemSettings | Obtient l'objet PSSystemSettings. | ||
Set-HubSystemSettings |
|
Définit les paramètres du système fournis à Devolutions Hub. |
Modifier certaines informations des paramètres du système et enregistrer ces modifications.
|
New-HubSystemVaultPermission |
|
Ajoute une permission système au Coffre fournie aux paramètres du système. Si un utilisateur ou un groupe existe déjà, la permission sera écrasée. Si UserId est fourni, définit un PSVaultRole prédéfini ou une permission personnalisée du Coffre au système pour cet utilisateur. ou Si GroupId est fourni, définit un PSVaultRole prédéfini ou une permission personnalisée du Coffre au système pour ce groupe. |
$newSystemVaultPermission = [Devolutions.Hub.Clients.VaultPermission]@{ AddEntries = $true }
|
Remove-HubSystemVaultPermission |
|
Si UserID est fourni, supprime la permission du Coffre au système de l'utilisateur des paramètres système. ou Si GroupId est fourni, supprime la permission du Coffre au système de l'utilisateur des paramètres système. |
|
Get-HubSystemVaultPermission |
ou
|
Si UserId est fourni, récupère la permission Coffre du système de l'utilisateur à partir des paramètres du système.
ou Si GroupId est fourni, récupère la permission Coffre de système de ce groupe à partir des paramètres du système. |
Récupérer une systemVaultPermission d'un utilisateur pour créer une nouvelle systemVaultPermission avec les mêmes permissions (valeurs).
|
Set-HubSystemVaultPermission |
|
Définit une permission de Coffre système fournie.
Si UserId est fourni, définit un PSVaultRole prédéfini ou une permission personnalisée du Coffre au système pour cet utilisateur. ou Si GroupId est fourni, définit un PSVaultRole prédéfini ou une permission personnalisée du Coffre au système pour ce groupe. |
$systemVaultPermission = Get-HubSystemVaultPermission -UserId 2d9221d6-3cbe-4161-b3aa-387f18a7f8c4
```Set-HubSystemVaultPermission -UserId 2d9221d6-3cbe-4161-b3aa-387f18a7f8c4 -SystemVaultPermission $systemVaultPermission `` |
New-HubSystemPermission |
|
Ajoute une permission système fournie aux paramètres du système. Si UserId est fourni, définit la permission système sur cet utilisateur. ou Si GroupId est fourni, définit la permission système sur ce groupe. |
$newSystemPermission = [Devolutions.Hub.Clients.SystemPermission]@{ AddVaults = $true }
|
Remove-HubSystemPermission |
|
Si UserId est fourni, supprime la permission système de cet utilisateur des paramètres système.
ou Si GroupId est fourni, supprime la permission système de ce groupe des paramètres système. |
|
Get-HubSystemPermission |
|
Si UserId est fourni, récupère la permission système de l'utilisateur à partir des paramètres système.
ou Si GroupId est fourni, récupère la permission système de ce groupe à partir des paramètres système. |
Récupérer une systemPermission d'un utilisateur pour créer une nouvelle systemPermission avec les mêmes permissions (valeurs).
|
Set-HubSystemPermission |
|
Définit une permission système fournie.
Si UserId est fourni, définit une permission système pour cet utilisateur. ou Si GroupId est fourni, définit une permission système pour ce groupe. |
$systemPermission = Get-HubSystemPermission -UserId 2d9221d6-3cbe-4161-b3aa-387f18a7f8c4
|
Devolutions Gateway
Cette section concerne les commandes permettant de gérer Devolutions Gateway.
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
New-HubGateway |
|
Ajoute un nouveau Devolutions Gateway au hub. |
$newDevolutionsGateway = [Devolutions.Hub.CryptoUtils.Models.PSDecryptedGateway]@{ PsMetadata = [Devolutions.Hub.CryptoUtils.Models.PSGatewayMetadata]@{ Name = 'Test Gateway From PS ' }}
|
Remove-HubGateway |
|
Supprime le Devolutions Gateway avec l'ID fourni. | |
Set-HubGateway |
|
Définit le Devolutions Gateway fourni. |
$psDecrpytedGateway = Get-HubGateway -GatewayId 4c6fb2dc-f7ba-4089-8bc2-b46b3bdcd1d0
|
Get-HubGateway |
|
Récupère le Devolutions Gateway avec l'ID fourni. | |
New-HubGatewaySettings |
Crée des nouveaux paramètres Devolutions Gateway. Si des paramètres existent déjà, ils seront écrasés. | ||
Set-HubGatewaySettings | Définit les paramètres de Devolutions Gateway fournis. | ||
Get-HubGatewaySettings | Récupère les paramètres de Devolutions Gateway. |
Coffre
Cette section concerne les commandes permettant de gérer les Coffres.
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
New-HubVault |
|
Ajoute un nouveau Coffre. | Avoir la permission de créer un Coffre et de mettre le nom. |
Remove-HubVault |
|
Supprime ce Coffre du hub. | |
Get-HubVault |
|
Si VaultId est fourni, récupère le Coffre par l'ID. Si VaultId n'est pas fourni, récupère tous les Coffres auxquels vous avez accès. |
|
Set-HubVault |
|
Définit le Coffre fourni sur l'ID du Coffre mentionné. |
Modifier certaines informations sur un Coffre et enregistrer ces modifications.
|
New-HubVaultPermission |
|
Ajoute la permission du Coffre fournie à un Coffre spécifique. Si un utilisateur ou un groupe existe déjà, la permission sera écrasée. Si UserId est fourni, définit un PSVaultRole prédéfini ou une permission du Coffre personnalisée pour cet utilisateur. Si GroupId est fourni, définit un PSVaultRole prédéfini ou une permission du Coffre personnalisée pour ce groupe. |
Avec une vaultPermission personnalisée :
ou Avec un rôle prédéfini :
|
Remove-HubVaultPermission |
|
Si UserId est fourni, supprime la permission du Coffre d'utilisateur d'un Coffre spécifique. Si GroupId est fourni, supprime la permission du Coffre du groupe d'un Coffre spécifique. |
|
Get-HubVaultPermission |
|
Si UserId est fourni, récupère la permission du Coffre d'utilisateur à partir d'un Coffre spécifique. Si GroupId est fourni, récupère la permission du Coffre du groupe à partir d'un Coffre spécifique. |
Obtenir une vaultPermission d'un utilisateur pour créer une nouvelle vaultPermission avec les mêmes permissions (valeurs).
|
Set-HubVaultPermission |
|
Définit une permission du Coffre fournie à un Coffre spécifique. Si UserId est fourni, définit un rôle prédéfini ou une permission du Coffre personnalisée pour cet utilisateur. Si GroupId est fourni, définit un rôle prédéfini ou une permission du Coffre personnalisée pour ce groupe. |
Avec une vaultPermission personnalisée :
ou Avec un rôle prédéfini :
|
Get-HubVaultRole |
|
Si RoleId est fourni, récupère le rôle du Coffre par l'ID. Si RoleId n'est pas fourni, récupère tous les rôles du Coffre. |
Utilisateur
Cette section concerne les commandes permettant de gérer les utilisateurs.
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
New-HubUser |
|
Ajoute un nouvel utilisateur Devolutions ou invite un utilisateur Devolutions existant.
Si IsTemporaryPasswordSendByEmail est fourni, le mot de passe temporaire du nouvel utilisateur Devolutions sera envoyé par courriel. Sinon, le mot de passe temporaire est renvoyé. |
|
New-HubOrganizationUser |
|
Invite un utilisateur d'une Organisation du Compte Devolutions définie dans votre hub.
Si Email, AllowOfflineInRDM et UserSendMessageConfiguration sont fournis. Un seul courriel sera envoyé. Si PSInvitation est fourni, vous pouvez manuellement définir plus d'un courriel et assigner des groupes. Cette commande fonctionnera seulement si l'option Activer l'authentification unique (SSO) pour l'organisation dans le Compte Devolutions a été activée dans votre hub et qu'une Organisation du Compte Devolutions y a été sélectionnée. |
Ajouter avec une PSInvitation.
|
Remove-HubUser |
|
Supprime cet utilisateur du hub. | |
Get-HubUser |
|
Si UserId est fourni, récupère l'utilisateur par ID.
Si UserId n'est pas fourni, récupère tous les utilisateurs. |
|
Set-HubUser |
|
Définit l'utilisateur fourni sur l'ID utilisateur mentionné. |
Désactiver un utilisateur et enregistrer.
|
Groupe
Cette section concerne les commandes pour gérer les groupes.
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
New-HubGroup |
|
Ajoute un nouveau groupe au Hub avec des utilisateurs, si fourni. |
|
Remove-HubGroup |
|
Supprime ce groupe du hub. | |
Get-HubGroup |
|
Si GroupId est fourni, récupére le groupe par ID.
Si GroupId n'est pas fourni, récupére tous les groupes. |
|
Set-HubGroup |
|
Définit le groupe fourni sur l'ID de groupe reçu. |
Modifier le nom, ajouter un utilisateur et enregistrer le groupe.
|
Add-HubGroupUser |
|
Ajoute un ou des utilisateurs à un groupe spécifique. | |
Remove-HubGroupUser |
|
Supprime un ou des utilisateurs d'un groupe spécifique. |
Entrée
Cette section concerne les commandes pour gérer les entrées.
Commande | Arguments | Description | Exemple de code |
---|---|---|---|
New-HubEntry |
|
Ajoute une nouvelle entrée à un Coffre spécifique de Devolutions Hub avec l'entrée PSDecryptedEntry fournie. |
$t = [Devolutions.Hub.CryptoUtils.Models.PSDecryptedEntry]@{ PsMetadata = [Devolutions.Hub.CryptoUtils.Models.PSEntryMetadata]@{ Name = “Test Cred“; ParentId = “9df41856-125a-490a-8589-93afc3059924“; ConnectionType = [Devolutions.Generated.Enums.ConnectionType]::Credential }; Connection = [Devolutions.Generated.Models.Connection]@{ Credentials = [Devolutions.Generated.Models.CredentialsConnection]@{ CredentialType = [Devolutions.Generated.Enums.CredentialResolverConnectionType]::Default; Password = “passworddepowershell“ } } }
|
Remove-HubEntry |
|
Supprime cette entrée d'un Coffre spécifique. | |
Get-HubEntry |
|
Si EntryId est fourni, récupère cette entrée à partir d'un Coffre spécifique.
Si EntryId n'est pas fourni, récupère toutes les entrées d'un Coffre spécifique. Les entrées auront des mots de passe sensibles si vous en avez la permission. |
|
Set-HubEntry |
|
Définit l'entrée PSDecryptedEntry fournie dans le Coffre et l'entrée mentionnée. |
Modifier certaines informations sur une entrée et enregistrer ces modifications.
|
New-HubEntryPermission |
|
Ajoute la permission de l'entrée fournie à une entrée spécifique. Si un utilisateur ou un groupe existe déjà, la permission sera écrasée. Si UserId est fourni, définit un rôle prédéfini ou une permission de l'entrée personnalisée pour cet utilisateur. ou Si GroupId est fourni, définit un rôle prédéfini ou une permission de l'entrée personnalisée pour ce groupe. |
Avec une entryPermission personnalisée :
ou Avec un rôle prédéfini :
|
Remove-HubEntryPermission |
|
Si UserId est fourni, supprime la permission de l'entrée de l'utilisateur de l'entrée spécifique. Si GroupId est fourni, supprime la permission de l'entrée du groupe de l'entrée spécifique. |
|
Get-HubEntryPermission |
|
Si UserId est fourni, récupère la permission de l'entrée de l'utilisateur de l'entrée spécifique. Si GroupId est fourni, récupère la permission de l'entrée du groupe de l'entrée spécifique. |
Obtenir une entryPermission d'un utilisateur pour créer une nouvelle entryPermission avec les mêmes permissions (valeurs).
|
Set-HubEntryPermission |
|
Définit une permission de l'entrée fournie à une entrée spécifique. Si UserId est fourni, définit un rôle prédéfini ou une permission de l'entrée personnalisée pour cet utilisateur. Si GroupId est fourni, définit un rôle prédéfini ou une permission de l'entrée personnalisée pour ce groupe. |
Avec une entryPermission personnalisée :
ou Avec un rôle prédéfini :
|
Get-HubEntryRole |
|
Si RoleId est fourni, récupère le rôle de l'entrée par l'ID.
Si RoleId n'est pas fourni, récupère tous les rôles de l'entrée. |