UIP ou paramètres

uip or settings lit et écrit les paramètres d'Orchestrator au niveau du locataire. Les paramètres sont des paires clé-valeur organisées par préfixe pointillé (Abp.Timing.*, Alerts.Email.*, Auth.*, Scalability.*, Triggers.*, etc.). Utilisez settings list pour découvrir les clés, settings get/update pour lire ou modifier une valeur unique, settings execution pour la configuration des paramètres d'exécution structurés (noms d'affichage et valeurs autorisées) et settings timezones pour répertorier les ID de fuseau horaire valides .

Synthèse

uip or settings <verb> [options]

Verbes

Verbe	Objectif
list	Répertoriez les paramètres du locataire.
get	Lisez un paramètre par clé.
update	Écrivez un paramètre par clé.
execution	Obtenez la configuration des paramètres d'exécution (étendue Global ou Robot).
timezones	Répertorie les ID de fuseau horaire disponibles.

Tous les verbes respectent les options globales (--output, --output-filter, --log-level, --log-file). Les codes de sortie suivent le contrat standard.

Clés de paramètre communes

Les catégories ci-dessous sont non exhaustives. Utilisez settings list pour tout découvrir.

• Général: Abp.Timing.TimeZone (ID de fuseau horaire — exécutez settings timezones pour répertorier les ID valides), Abp.Localization.DefaultLanguageName (par exemple, en, fr, de).
• Alertes par e-mail: Alerts.Email.Enabled, Abp.Net.Mail.Smtp.Host, .Port, .UserName, .Password, .EnableSsl, .UseDefaultCredentials, Abp.Net.Mail.DefaultFromAddress.
• Sécurité des Robots: Auth.Robot.EnforceAuthenticationToken, Auth.UnattendedRobot.ForceClientCredentials, AttendedRobot.RunDisconnectedHours (entier; 0 désactive).
• Déploiement: DeploymentUrl, NuGet.Packages.ApiKey, Deployment.Libraries.Url, NuGet.Activities.ApiKey, Deployment.Processes.AuthenticationType (Secure/apiKey).
• Évolutivité: Scalability.SignalR.Enabled, Scalability.SignalR.Transport (masc de bits: 1 WebSockets, 2 SSE, 4 LongInterrogation, 7 toutes), Scalability.Heartbeat.PeriodSeconds (par défaut 30), Scalability.Heartbeat.FailureThreshold (par défaut 4).
• Déclencheurs: Triggers.DisableWhenFailedCount (par défaut 10), Triggers.DisableWhenFailingSinceDays (par défaut 1), Triggers.JobsCountStrategy (PERPROCESS/PERTRIGGER), QueueTrigger.ActivationFrequencyInMinutes (par défaut 30), ConnectedTriggers.AutoDisableJobFailuresThreshold (par défaut 5).
• File d'attente: inProgressMaxNumberOfMinutes (par défaut 1440 = 24 h).
• Tâches: Jobs.TerminatingJobsTimeout (par défaut 1440 minutes = 24 h).

liste d’IU ou de paramètres

Répertoriez les paramètres du locataire. Vous pouvez éventuellement filtrer par étendue.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--scope	ENUM	—	Application, Tenant, User, All.
-l	--limit	Numérique	100	Taille de la page.
—	--offset	Numérique	0	Nombre d'ignorers.

Exemples

uip or settings list
uip or settings list --scope Tenant --limit 200
uip or settings list --output-filter 'Data[].name'

Format des données (--sortie json)

{
  "Code": "SettingsList",
  "Data": [
    { "name": "Abp.Timing.TimeZone", "value": "UTC", "id": "Abp.Timing.TimeZone" },
    { "name": "Alerts.Email.Enabled", "value": "true", "id": "Alerts.Email.Enabled" }
  ]
}

uip ou paramètres obtenir

Lisez un paramètre par clé.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de paramètre (par exemple, Abp.Timing.TimeZone).

Options

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

Exemples

uip or settings get Abp.Timing.TimeZone
uip or settings get Alerts.Email.Enabled --output-filter 'Data.Value'

Format des données (--sortie json)

{
  "Code": "SettingsGet",
  "Data": {
    "Key": "Abp.Timing.TimeZone",
    "Value": "UTC"
  }
}

mise à jour de l’IU ou des paramètres

Écrivez un paramètre par clé.

Arguments

Nom	Requis	Objectif
<key>	oui	Clé de paramètre.
<value>	oui	Nouvelle valeur (chaîne; la validation côté serveur s’applique).

Options

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

Exemples

uip or settings update Abp.Timing.TimeZone Europe/Bucharest
uip or settings update Alerts.Email.Enabled true

Format des données (--sortie json)

{
  "Code": "SettingsUpdated",
  "Data": {
    "Key": "Abp.Timing.TimeZone",
    "Value": "Europe/Bucharest",
    "Status": "Updated successfully"
  }
}

exécution de l’IU ou des paramètres

Obtenez la configuration des paramètres d'exécution structurés pour l'étendue Global (0) ou Robot (1). Chaque entrée comprend un nom complet, un type de valeur (Boolean, MultipleChoice, etc.), une valeur par défaut et, pour les types de choix, la liste des valeurs autorisées.

Options

Short	Long	Valeur (Value)	Default	Description
-t	--tenant	name	session par défaut	Remplacer le locataire.
—	--scope	0 ou 1	0	Étendue des paramètres: globale (0) ou Robot (1).

Exemples

# Global execution settings
uip or settings execution

# Robot-scoped execution settings
uip or settings execution --scope 1

# Just the keys and their allowed values
uip or settings execution \
    --output-filter 'Data._configuration[].{k:key, vals:possibleValues}'

Format des données (--sortie json)

{
  "Code": "ExecutionSettings",
  "Data": {
    "scope": "Global",
    "_configuration": [
      {
        "key": "TracingLevel",
        "displayName": "Logging Level",
        "valueType": "MultipleChoice",
        "defaultValue": "Information",
        "possibleValues": [
          "Verbose", "Trace", "Information", "Warning", "Error", "Critical", "Off"
        ]
      },
      {
        "key": "LoginToConsole",
        "displayName": "Login To Console",
        "valueType": "Boolean",
        "defaultValue": "true",
        "possibleValues": []
      }
    ]
  }
}

UIP ou paramètres fuseaux horaires

Répertorie les identifiants de fuseau horaire reconnus par Orchestrator. Il s'agit des valeurs valides pour Abp.Timing.TimeZone et pour --time-zone dans uip or calendars.

Options

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

Exemples

uip or settings timezones
uip or settings timezones --output-filter 'Data[].value'

Format des données (--sortie json)

{
  "Code": "TimezoneList",
  "Data": [
    { "name": "(UTC) Coordinated Universal Time", "value": "UTC" },
    { "name": "(UTC+02:00) Bucharest", "value": "GTB Standard Time" }
  ]
}

Commandes associées

• Les valeurs uip or calendars — --time-zone proviennent de settings timezones.
• uip or audit-logs — filtrer avec --component Settings pour voir les modifications de paramètres.

Voir également

• Options globales — --output, --output-filter, --log-level, --log-file.
• Codes de sortie — contrat de code de sortie standard.