UIP ou configurações

Sintaxe e opções para "uip or Configurations", que lê e grava as configurações do Orchestrator no nível do tenant por chave de ponto.

uip or settings lê e grava configurações do Orchestrator no nível do tenant. As configurações são pares de chave-valor organizados por prefixo pontilhado (Abp.Timing.*, Alerts.Email.*, Auth.*, Scalability.*, Triggers.*, etc.). Use settings list para descobrir chaves, settings get/update para ler ou alterar um único valor, settings execution para a configuração de configurações de execução estruturada (nomes de exibição e valores permitidos) e settings timezones para listar IDs de fuso horário válidos .

Resumo

uip or settings <verb> [options]

Verbo

Texto	Finalidade
list	Listar as configurações do tenant.
get	Leia uma configuração por tecla.
update	Escreva uma configuração por tecla.
execution	Obtenha a configuração das configurações de execução (escopo global ou de robô).
timezones	Listar os IDs de fuso horário disponíveis.

Todos os verbos honram as opções globais (--output, --output-filter, --log-level, --log-file). Os códigos de saída seguem o contrato padrão.

Teclas de configuração comuns

As categorias abaixo são não exaustivas — use settings list para descobrir tudo.

• Geral: Abp.Timing.TimeZone (ID do fuso horário — execute settings timezones para listar IDs válidos), Abp.Localization.DefaultLanguageName (por exemplo, en, fr, de).
• Alertas de e-mail: Alerts.Email.Enabled, Abp.Net.Mail.Smtp.Host, .Port, .UserName, .Password, .EnableSsl, .UseDefaultCredentials, Abp.Net.Mail.DefaultFromAddress.
• Segurança do robô: Auth.Robot.EnforceAuthenticationToken, Auth.UnattendedRobot.ForceClientCredentials, AttendedRobot.RunDisconnectedHours (inteiro; 0 desabilita).
• Implantação: DeploymentUrl, NuGet.Packages.ApiKey, Deployment.Libraries.Url, NuGet.Activities.ApiKey, Deployment.Processes.AuthenticationType (Secure/apiKey).
• Escalabilidade: Scalability.SignalR.Enabled, Scalability.SignalR.Transport (bitmask: 1 WebSockets, 2 SSE, 4 LongPolling, 7 todos), Scalability.Heartbeat.PeriodSeconds (padrão 30), Scalability.Heartbeat.FailureThreshold (padrão 4).
• Gatilhos: Triggers.DisableWhenFailedCount (padrão 10), Triggers.DisableWhenFailingSinceDays (padrão 1), Triggers.JobsCountStrategy (PERPROCESS/PERTRIGGER), QueueTrigger.ActivationFrequencyInMinutes (padrão 30), ConnectedTriggers.AutoDisableJobFailuresThreshold (padrão 5).
• Fila: inProgressMaxNumberOfMinutes (padrão 1440 = 24 a).
• Trabalhos: Jobs.TerminatingJobsTimeout (padrão 1440 minutos = 24 horas).

uip ou lista de configurações

Listar as configurações do tenant. Filtre opcionalmente por escopo.

Opções

Short	Long	Valor	Padrão	Description
—	--scope	ENUM	—	Application, Tenant, User, All.
-l	--limit	Número	100	Tamanho da página
—	--offset	Número	0	Ignorar contagem.

Exemplos

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

Formato dos dados (--output 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 configurações obter

Leia uma configuração por tecla.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de configuração (por exemplo, Abp.Timing.TimeZone).

Opções

Short	Long	Valor	Padrão	Description

Exemplos

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

Formato dos dados (--output json)

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

Atualização da uip ou das configurações

Escreva uma configuração por tecla.

Argumentos

Name	Required	Finalidade
<key>	sim	Chave de configuração.
<value>	sim	Novo valor (string; a validação do lado do servidor se aplica).

Opções

Short	Long	Valor	Padrão	Description

Exemplos

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

Formato dos dados (--output json)

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

UIP ou execução de configurações

Obtenha a configuração de configurações de execução estruturada para escopo Global (0) ou Robô (1). Cada entrada inclui um nome de exibição, tipo de valor (Boolean, MultipleChoice etc.), valor padrão e — para tipos de escolha — a lista de valores permitidos.

Opções

Short	Long	Valor	Padrão	Description
—	--scope	0 ou 1	0	Escopo das configurações: Global (0) ou Robô (1).

Exemplos

# 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}'

Formato dos dados (--output 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 configurações fusos horários

Liste os IDs de fuso horário reconhecidos pelo Orchestrator. Esses são os valores válidos para Abp.Timing.TimeZone e para --time-zone em uip or calendars.

Opções

Short	Long	Valor	Padrão	Description

Exemplos

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

Formato dos dados (--output json)

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

Comandos relacionados

• uip or calendars — --time-zone os valores vêm de settings timezones.
• uip or audit-logs — filtre com --component Settings para ver as alterações de configuração.

Veja também

• Opções globais — --output, --output-filter, --log-level, --log-file.
• Códigos de saída — contrato de código de saída padrão.