UiPath Documentation
uipath-cli
latest
false
Important :
Ce contenu a été traduit à l'aide d'une traduction automatique. La localisation du contenu nouvellement publié peut prendre 1 à 2 semaines avant d’être disponible.

Guide de l'utilisateur de UiPath CLI

uip ou licences

uip or licenses inspecte et gère l'attribution des licences Orchestrator. Répertoriez les attributions de licences de runtime et d'utilisateur nommé, activez ou désactivez la licence de machine et affichez le résumé global de la licence de locataire (autorisée vs utilisée par type de robot).

Synthèse

uip or licenses <verb> [options]
uip or licenses <verb> [options]

Verbes

VerbeObjectif
listRépertoriez les attributions de licences pour un type de robot donné (runtime ou Named User).
toggleActivez ou désactivez les licences de machine pour un type de robot de runtime spécifique.
infoAfficher le résumé de la licence du locataire (plan d'abonnement, autorisations/utilisations, fonctionnalités).

Référence du type de robot

L'indicateur --type accepte ces types de robots. Le comportement de la commande se divise en deux compartiments:

  • Types de runtime — affectation au niveau de la machine: Unattended, NonProduction, Headless, TestAutomation.
  • Types d'utilisateurs nommés — attribution au niveau de l'utilisateur: Attended, Development, Studio, StudioX, RpaDeveloper, CitizenDeveloper.

licenses list accepte les deux compartiments; licenses toggle accepte uniquement les types de runtime.

liste des licences ou UiP

Répertoriez les attributions de licences pour un type de robot donné.

  • Pour les types de runtime, chaque ligne représente une machine avec un robot connecté; MachineName, MachineType, Runtimes, IsOnline, IsLicensed et Enabled sont renvoyés.
  • Pour les types d'utilisateurs nommés, chaque ligne représente un utilisateur; UserName, LastLoginDate, MachinesCount, IsLicensed et MachineNames sont renvoyés.

Options

ShortLongValeur (Value)DefaultDescription
-t--tenantnamesession par défautRemplacer le locataire.
--typeENUMrequisType de robot (voir la liste ci-dessus).
--licensedDrapeaudésactivéEntrées sous licence uniquement. Capture mutuellement exclusive avec --unlicensed
--unlicensedDrapeaudésactivéUniquement les entrées sans licence. Capture mutuellement exclusive avec --licensed
-l--limitNumérique50Taille de la page.
--offsetNumérique0Nombre d'ignorers.
--order-byChampTri OData (par exemple, MachineName desc).

Exemples

uip or licenses list --type Unattended --limit 50
uip or licenses list --type Attended --unlicensed
uip or licenses list --type Unattended \
    --output-filter 'Data[?IsOnline].MachineName'
uip or licenses list --type Unattended --limit 50
uip or licenses list --type Attended --unlicensed
uip or licenses list --type Unattended \
    --output-filter 'Data[?IsOnline].MachineName'

Format des données (--sortie json)

Type de runtime :

{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "MachineName": "prod-worker-01",
      "MachineType": "Standard",
      "Runtimes": 3,
      "IsOnline": true,
      "IsLicensed": true,
      "Enabled": true
    }
  ]
}
{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "MachineName": "prod-worker-01",
      "MachineType": "Standard",
      "Runtimes": 3,
      "IsOnline": true,
      "IsLicensed": true,
      "Enabled": true
    }
  ]
}

Type d'utilisateur nommé:

{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "dev@example.com",
      "LastLoginDate": "2025-04-15T10:30:00Z",
      "MachinesCount": 2,
      "IsLicensed": true,
      "MachineNames": ["studio-01", "studio-02"]
    }
  ]
}
{
  "Code": "LicenseList",
  "Data": [
    {
      "Key": "d4e5f6a7-0000-0000-0000-000000000001",
      "UserName": "dev@example.com",
      "LastLoginDate": "2025-04-15T10:30:00Z",
      "MachinesCount": 2,
      "IsLicensed": true,
      "MachineNames": ["studio-01", "studio-02"]
    }
  ]
}

basculement uip ou de licences

Activez ou désactivez les licences de machine pour un type de robot de runtime spécifique. Les types d'utilisateurs nommés sont rejetés. Accepte une clé de machine — résolue en interne en un nom de machine avant d'appeler l'API.

L’un des éléments --enable ou --disable doit être fourni.

Arguments

NomRequisObjectif
<machine-key>ouiClé de machine. Recherchez-le avec machines list.

Options

ShortLongValeur (Value)DefaultDescription
-t--tenantnamesession par défautRemplacer le locataire.
--typeENUMrequisType de robot Runtime uniquement: Unattended, NonProduction, Headless, TestAutomation.
--enableDrapeauActivez les licences.
--disableDrapeauDésactiver la gestion des licences.

Exemples

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type NonProduction --disable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable --output-filter 'Data.Status'
uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type NonProduction --disable

uip or licenses toggle a1b2c3d4-0000-0000-0000-000000000001 \
    --type Unattended --enable --output-filter 'Data.Status'

Format des données (--sortie json)

{
  "Code": "LicenseToggle",
  "Data": {
    "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "MachineName": "prod-worker-01",
    "RobotType": "Unattended",
    "Enabled": true,
    "Status": "Licensing enabled"
  }
}
{
  "Code": "LicenseToggle",
  "Data": {
    "MachineKey": "a1b2c3d4-0000-0000-0000-000000000001",
    "MachineName": "prod-worker-01",
    "RobotType": "Unattended",
    "Enabled": true,
    "Status": "Licensing enabled"
  }
}

informations sur l’uip ou les licences

Affichez le résumé de la licence du locataire: plan d'abonnement, nombres autorisés et utilisés par type de robot, statut d'expiration et fonctionnalités sous licence. Utilisez cette option pour vérifier la capacité globale avant l'affectation.

Options

ShortLongValeur (Value)DefaultDescription
-t--tenantnamesession par défautRemplacer le locataire.

Exemples

uip or licenses info
uip or licenses info --output-filter 'Data.Used'
uip or licenses info --output table
uip or licenses info
uip or licenses info --output-filter 'Data.Used'
uip or licenses info --output table

Format des données (--sortie json)

{
  "Code": "LicenseInfo",
  "Data": {
    "IsExpired": false,
    "SubscriptionPlan": "Enterprise",
    "Allowed": { "Unattended": 10, "Attended": 20 },
    "Used": { "Unattended": 4, "Attended": 7 },
    "LicensedFeatures": ["AISuite", "TestManager"]
  }
}
{
  "Code": "LicenseInfo",
  "Data": {
    "IsExpired": false,
    "SubscriptionPlan": "Enterprise",
    "Allowed": { "Unattended": 10, "Attended": 20 },
    "Used": { "Unattended": 4, "Attended": 7 },
    "LicensedFeatures": ["AISuite", "TestManager"]
  }
}

Codes de sortie

Voir Codes de sortie. Aucun remplacement spécifique au verbe.

  • uip or machines — gérez les machines et l'affectation des emplacements.
  • uip or users--license-type sur users create et users edit

Voir également

Cette page vous a-t-elle été utile ?

Connecter

Besoin d'aide ? Assistance

Vous souhaitez apprendre ? UiPath Academy

Vous avez des questions ? UiPath Forum

Rester à jour