uip ou machines

Syntaxe et options pour `uip ou machines`, qui gère les modèles de machine définissant l'endroit où les robots s'exécutent et le nombre d'emplacements de licence attribués.

uip or machines gère les modèles de machine - définitions de l'hôte du robot qui décrivent où les robots s'exécutent et combien d'emplacements de licence de chaque type sont alloués. Les machines sont à l'échelle des locataires, mais peuvent être affectées à des dossiers spécifiques.

Synthèse

uip or machines <verb> [options]

Verbes

Verbe	Objectif
list	Répertoriez les machines du locataire ou les machines affectées à un dossier spécifique.
get	Récupérez une machine par clé.
create	Créez un nouveau modèle de machine (éventuellement sans serveur).
edit	Modifiez le nom, la description ou l'affectation d'emplacement d'une machine.
delete	Supprimez une ou plusieurs machines.
assign	Affectez des machines à un dossier.
unassign	Supprimez des machines d'un dossier.

liste uip ou machines

Lister les machines Sans --folder-key ou --folder-path, renvoie chaque machine du locataire. Avec l'un ou l'autre indicateur, renvoie uniquement les machines affectées à ce dossier.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--folder-key	GUID	—	Étendue à un dossier par clé.
—	--folder-path	Chemin d'accès	—	Étendue à un dossier par chemin.
-n	--name	text	—	Contient une correspondance sur le nom de la machine.
—	--scope	ENUM	—	Default, Shared, PersonalWorkspace, Cloud, Serverless, AutomationCloudRobot, ElasticRobot
-l	--limit	Numérique	50	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.
—	--order-by	Champ	Id desc	Tri OData.
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API.

Exemples

uip or machines list --limit 10
uip or machines list --folder-path "Shared"
uip or machines list --scope Serverless \
    --output-filter 'Data[].{name:Name, slots:UnattendedSlots}'

Format des données (--sortie json)

{
  "Code": "MachineList",
  "Data": [
    {
      "Name": "prod-worker-01",
      "ID": 101,
      "Key": "a1b2c3d4-0000-0000-0000-000000000001",
      "Type": "Standard",
      "Scope": "Default",
      "Description": "",
      "UnattendedSlots": 3,
      "HeadlessSlots": 0,
      "NonProductionSlots": 0,
      "TestAutomationSlots": 0,
      "LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
    }
  ],
  "Pagination": { "Returned": 1, "Limit": 50, "Offset": 0, "HasMore": false }
}

uip ou machines obtenir

Récupérer une machine par clé GUID. Aucun contexte de dossier requis - les machines sont à l'échelle du locataire.

Arguments

Nom	Requis	Objectif
<machine-key>	oui	Clé de machine. Recherchez-le avec machines list.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--all-fields	Drapeau	désactivé	Renvoyez la charge utile complète de l'API.

Exemples

uip or machines get a1b2c3d4-0000-0000-0000-000000000001
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 --all-fields
uip or machines get a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.UnattendedSlots'

Format des données (--sortie json)

{
  "Code": "MachineGet",
  "Data": {
    "Name": "prod-worker-01",
    "ID": 101,
    "Key": "a1b2c3d4-0000-0000-0000-000000000001",
    "Type": "Standard",
    "Scope": "Default",
    "Description": "",
    "UnattendedSlots": 3,
    "HeadlessSlots": 0,
    "NonProductionSlots": 0,
    "TestAutomationSlots": 0,
    "LicenseKey": "b1c2d3e4-0000-0000-0000-000000000100"
  }
}

uip ou machines créer

Créez un nouveau modèle de machine. --name est requis; avec --serverless, la machine est créée en tant que modèle hébergé dans le cloud.

Options

Short	Long	Valeur (Value)	Default	Description
-n	--name	text	requis	Nom de la machine (doit être unique au sein du locataire).
-d	--description	text	—	Description de la machine.
—	--serverless	Drapeau	désactivé	Créez une machine sans serveur (hébergée dans le cloud).
—	--unattended-slots	Numérique	—	Emplacements pour le Unattended Robot.
—	--headless-slots	Numérique	—	Emplacements pour le robot sans affichage.
—	--non-production-slots	Numérique	—	Emplacements de non-production.
—	--testing-slots	Numérique	—	Emplacements du robot d'automatisation des tests.
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

uip or machines create --name "staging-worker" --unattended-slots 2

uip or machines create --name "serverless-pool" --serverless \
    --unattended-slots 10

uip or machines create --name "qa-host" --unattended-slots 1 --testing-slots 2 \
    --output-filter 'Data.Key'

Format des données (--sortie json)

{
  "Code": "MachineCreated",
  "Data": {
    "Name": "staging-worker",
    "ID": 103,
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Type": "Template",
    "Scope": "Default",
    "Description": "",
    "UnattendedSlots": 2,
    "HeadlessSlots": 0,
    "NonProductionSlots": 0,
    "TestAutomationSlots": 0,
    "LicenseKey": ""
  }
}

modification de l'interface utilisateur ou des machines

Modifiez le nom, la description ou l'affectation d'emplacement d'une machine. Seules les options fournies sont mises à jour; les champs omis restent inchangés.

Arguments

Nom	Requis	Objectif
<machine-key>	oui	Clé de machine.

Options

Short	Long	Valeur (Value)	Default	Description
-n	--name	text	—	Nouveau nom de machine.
-d	--description	text	—	Nouvelle description de la machine.
—	--unattended-slots	Numérique	—	Emplacements pour le Unattended Robot.
—	--headless-slots	Numérique	—	Emplacements pour le robot sans affichage.
—	--non-production-slots	Numérique	—	Emplacements de non-production.
—	--testing-slots	Numérique	—	Emplacements du robot d'automatisation des tests.
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 --unattended-slots 5
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
    --name "staging-worker-eu" --description "EU staging host"
uip or machines edit a1b2c3d4-0000-0000-0000-000000000010 \
    --unattended-slots 5 --output-filter 'Data.Status'

Format des données (--sortie json)

{
  "Code": "MachineUpdate",
  "Data": {
    "Key": "a1b2c3d4-0000-0000-0000-000000000010",
    "Name": "staging-worker",
    "Status": "Updated successfully"
  }
}

suppression de l’interface utilisateur ou des machines

Supprimez une ou plusieurs machines. Une seule clé utilise DeleteById; plusieurs clés utilisent l'API en bloc. Les machines doivent être désaffectées de tous les dossiers avant la suppression.

Arguments

Nom	Requis	Objectif
<machine-keys...>	oui	Une ou plusieurs clés de machine.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.

Exemples

uip or machines delete a1b2c3d4-0000-0000-0000-000000000010
uip or machines delete key-1 key-2 key-3
uip or machines delete key-1 key-2 --output-filter 'Data.Count'

Format des données (--sortie json)

{
  "Code": "MachineDelete",
  "Data": {
    "Deleted": [
      { "Key": "a1b2c3d4-0000-0000-0000-000000000010", "Name": "staging-worker" }
    ],
    "Count": 1,
    "Status": "Deleted successfully"
  }
}

affectation d’UIP ou de machines

Affectez une ou plusieurs machines à un dossier. Nécessite --folder-path ou --folder-key.

Arguments

Nom	Requis	Objectif
<machine-keys...>	oui	Une ou plusieurs clés de machine.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--folder-path	Chemin d'accès	—	Dossier cible par chemin.
—	--folder-key	GUID	—	Dossier cible par clé.

Exemples

uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or machines assign key-1 key-2 --folder-key b1c2d3e4-0000-0000-0000-000000000001

uip or machines assign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Status'

Format des données (--sortie json)

{
  "Code": "MachineAssign",
  "Data": {
    "MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
    "FolderPath": "Shared",
    "Count": 1,
    "Status": "Assigned successfully"
  }
}

Annuler l’affectation de UIP ou de machines

Supprimez des machines d'un dossier. Les machines ne sont pas supprimées: seule leur affectation de dossier est supprimée. Nécessite --folder-path ou --folder-key.

Arguments

Nom	Requis	Objectif
<machine-keys...>	oui	Une ou plusieurs clés de machine.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--folder-path	Chemin d'accès	—	Dossier duquel désaffecter.
—	--folder-key	GUID	—	Dossier duquel désaffecter.

Exemples

uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared"

uip or machines unassign key-1 key-2 --folder-path "Production"

uip or machines unassign a1b2c3d4-0000-0000-0000-000000000001 \
    --folder-path "Shared" --output-filter 'Data.Count'

Format des données (--sortie json)

{
  "Code": "MachineUnassign",
  "Data": {
    "MachineKeys": ["a1b2c3d4-0000-0000-0000-000000000001"],
    "FolderPath": "Shared",
    "Count": 1,
    "Status": "Unassigned successfully"
  }
}

Codes de sortie

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

Commandes associées

• uip or folders , notamment folders runtimes pour inspecter l'affectation des machines côté dossier.
• uip or licenses — licenses toggle active/désactive la concession de licence sur une machine spécifique.
• uip or jobs — jobs start --machine-keys cible des machines spécifiques.

Voir également

• Options globales.