UiPath Documentation
uipath-cli
latest
false
Guia do usuário da UiPath CLI
Importante :
Este conteúdo foi traduzido com auxílio de tradução automática. A localização de um conteúdo recém-publicado pode levar de 1 a 2 semanas para ficar disponível.

uip admin-restrição de IP

Sintaxe e opções para "uip admin ip-restriction", que gerencia lista de permissões de intervalo de IP, aplicação e passagem para uma organização por meio do Serviço de Gerenciamento de Política de Acesso.

uip admin ip-restriction gerencia as políticas de restrição de IP da UiPath para a organização do chamador, apoiado pelo Serviço de Gerenciamento de Política de Acesso (APMS). Quatro grupos de subcomando: ip-ranges (a lista de permissões de CIDRs/IP confiáveis), enforcement (o botão on/off que realmente bloqueia o acesso por essa lista de permissões), bypass-rules (exceções de padrão de URL à lista de permissões) e my-ip (Mostra o IP público que a plataforma vê para o chamador — a ferramenta que um leitor usa antes de tocar em qualquer um dos outros dois).

Observação:

Risco de bloqueio. Habilitar a aplicação (enforcement enable) ou remover uma entrada de intervalo de IP (ip-ranges delete) enquanto a aplicação estiver ativada pode bloquear o chamador — ou toda a organização — fora da UiPath se o IP errado terminar excluído. Ambos os comandos exigem --confirm, e a CLI executa suas próprias verificações de segurança de simulação (abaixo) antes de fazer a chamada — mas as verificações são o melhor esforço, não uma substituição para a verificação dupla com my-ip e ip-ranges list primeiro. .

Resumo​

uip admin ip-restriction ip-ranges list [--filter <fragment>]
uip admin ip-restriction ip-ranges get [<id>] [--cidr <cidr>]
uip admin ip-restriction ip-ranges create [--name <name> --cidr <cidr>... | --name <name> --start-ip <ip> --end-ip <ip> | --file <path>] [--expires <duration>]
uip admin ip-restriction ip-ranges update <id> [--name <name>] [--cidr <cidr>] [--start-ip <ip>] [--end-ip <ip>] [--file <path>]
uip admin ip-restriction ip-ranges delete [<id>] [--cidr <cidr>] --confirm

uip admin ip-restriction enforcement get
uip admin ip-restriction enforcement enable --confirm
uip admin ip-restriction enforcement disable

uip admin ip-restriction bypass-rules list [--filter <fragment>]
uip admin ip-restriction bypass-rules get <id>
uip admin ip-restriction bypass-rules create --file <path>
uip admin ip-restriction bypass-rules update <id> [--regex-entry <pattern> | --file <path>]
uip admin ip-restriction bypass-rules delete <id>

uip admin ip-restriction my-ip
uip admin ip-restriction ip-ranges list [--filter <fragment>]
uip admin ip-restriction ip-ranges get [<id>] [--cidr <cidr>]
uip admin ip-restriction ip-ranges create [--name <name> --cidr <cidr>... | --name <name> --start-ip <ip> --end-ip <ip> | --file <path>] [--expires <duration>]
uip admin ip-restriction ip-ranges update <id> [--name <name>] [--cidr <cidr>] [--start-ip <ip>] [--end-ip <ip>] [--file <path>]
uip admin ip-restriction ip-ranges delete [<id>] [--cidr <cidr>] --confirm

uip admin ip-restriction enforcement get
uip admin ip-restriction enforcement enable --confirm
uip admin ip-restriction enforcement disable

uip admin ip-restriction bypass-rules list [--filter <fragment>]
uip admin ip-restriction bypass-rules get <id>
uip admin ip-restriction bypass-rules create --file <path>
uip admin ip-restriction bypass-rules update <id> [--regex-entry <pattern> | --file <path>]
uip admin ip-restriction bypass-rules delete <id>

uip admin ip-restriction my-ip

Cada verbo aceita --login-validity <minutes> (substitua o tempo de vida do token de login interativo para essa chamada; raramente necessário).

Conceitos​

  • Upsert idempotente em ip-ranges create — a chamada é um PUT chaveado no CIDR: executá-lo duas vezes com o mesmo --cidr é um erro não operacional seguro, não um erro de entrada duplicada.
  • Duas maneiras de identificar uma entrada — ip-ranges get/delete aceitar o UUID da entrada posicionalmente ou --cidr <cidr> para procurá-lo por valor (o CLI lista entradas e correspondências). Passar ambos, ou nenhum, é um erro do lado do cliente. Se --cidr corresponder a mais de uma entrada, o comando recusa e pede que você use o UUID.
  • Testes anteriores de segurança de bloqueio — enforcement enable primeiras chamadas my-ip e verifica o resultado em relação a cada CIDR em ip-ranges list; se o IP do chamador não for coberto, a chamada será rejeitada antes de atingir a plataforma. ip-ranges delete executa uma verificação semelhante apenas quando a aplicação já está em andamento: ele se recusa a excluir a única entrada restante da organização e se recusa a excluir uma entrada que cobre exclusivamente o próprio IP do chamador (a menos que outra entrada também o cubra). Ambas as verificações são apenas CIDR — uma entrada somente de IP de início/fim não é correspondente à verificação de IP do chamador, portanto, a "última entrada" verificar é o bloqueio real para eles.
  • --file versus em linha — ip-ranges create/update e bypass-rules create/update aceitam um corpo de solicitação JSON completo por meio de --file <path> ou um conjunto mais restrito de sinalizadores em linha. Os dois são mutuamente exclusivos; não passar nenhum (ou um conjunto embutido incompleto) é um erro do lado do cliente antes de qualquer chamada de rede.

intervalos de IP-restrição de IP do administrador do uip​

Gerenciar a lista de permissões de IP da organização. Uma entrada é um bloco CIDR, um intervalo de IP de início/fim ou uma lista de CIDRs.

lista de intervalos de IP da restrição de ip do administrador do uip​

Opções​
LongValorDescription
--filter <fragment>StringFiltro de substring sem diferenciação de maiúsculas e minúsculas no name da entrada, aplicado no lado do cliente.
Exemplo​
uip admin ip-restriction ip-ranges list --filter office
uip admin ip-restriction ip-ranges list --filter office
Formato dos dados (--output json)​
{
  "Code": "ApmsIpRangesList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Office VPN", "ipNetwork": "10.0.0.0/16" }
  ]
}
{
  "Code": "ApmsIpRangesList",
  "Data": [
    { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Office VPN", "ipNetwork": "10.0.0.0/16" }
  ]
}

uip admin ip-restrition ip-intervalos obter​

Argumentos​
NameRequiredFinalidade
[id]condicionalmenteUUID de entrada. Omita apenas quando --cidr for passado.
Opções​
LongValorDescription
--cidr <cidr>StringProcure a entrada por CIDR em vez de id. mutuamente exclusivo com o id de posição; exatamente um dos dois é necessário.
Exemplo​
uip admin ip-restriction ip-ranges get --cidr 10.0.0.0/16
uip admin ip-restriction ip-ranges get --cidr 10.0.0.0/16
Formato dos dados (--output json)​
{
  "Code": "ApmsIpRangeGet",
  "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Office VPN", "ipNetwork": "10.0.0.0/16" }
}
{
  "Code": "ApmsIpRangeGet",
  "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Office VPN", "ipNetwork": "10.0.0.0/16" }
}

criação de intervalos de ip-restrição de IP do administrador uiip​

Opções​
LongValorRequiredDescription
--file <path>PathcondicionalmenteCorpo AddIpConfigurationRequest JSON completo. mutuamente exclusivo com cada sinalizador incorporado abaixo.
--name <name>Stringmodo em linha: simNome de exibição para a entrada.
--cidr <cidr>string, repetívelmodo em linha: um de --cidr ou --start-ip+--end-ipBloco CIDR para permitir, por exemplo 10.0.0.0/16). Repita o sinalizador para adicionar vários CIDRs em uma chamada. mutuamente exclusivo com --start-ip/--end-ip.
--start-ip <ip>IPemparelhado com --end-ipInício de um intervalo de IP (formato legado).
--end-ip <ip>IPemparelhado com --start-ipFim de um intervalo de IP. Deve ser fornecido com --start-ip.
--expires <duration><integer><m|h|d|w>nãoExpiração opcional, por exemplo 15m, 2h, 30d, 1w. Intervalo: de 1 minuto a 10 anos.
Exemplos​
uip admin ip-restriction ip-ranges create --name 'Office VPN' --cidr 10.0.0.0/16
uip admin ip-restriction ip-ranges create --name 'Office VPN' --cidr 10.0.0.0/16
uip admin ip-restriction ip-ranges create --name 'Datacenter A' \
  --cidr 10.0.0.0/16 --cidr 192.168.0.0/24 --expires 30d
uip admin ip-restriction ip-ranges create --name 'Datacenter A' \
  --cidr 10.0.0.0/16 --cidr 192.168.0.0/24 --expires 30d
uip admin ip-restriction ip-ranges create --name Office --start-ip 10.0.0.1 --end-ip 10.0.0.50
uip admin ip-restriction ip-ranges create --name Office --start-ip 10.0.0.1 --end-ip 10.0.0.50
Formato dos dados (--output json)​
{ "Code": "ApmsIpRangeCreated", "Data": [{ "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Office VPN" }] }
{ "Code": "ApmsIpRangeCreated", "Data": [{ "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Office VPN" }] }

atualização de ip-restrição de IP do administrador do uip​

Argumentos​
NameRequiredFinalidade
<id>simUUID de entrada.
Opções​
LongValorDescription
--file <path>PathCorpo UpdateIpConfigurationRequest JSON completo. Exclusivo mutuamente com os sinalizadores incorporados abaixo.
--name <name>StringNovo nome de exibição.
--cidr <cidr>StringNovo CIDR a ser definido na entrada.
--start-ip <ip>IPNovo início do intervalo.
--end-ip <ip>IPNovo fim do intervalo.

Pelo menos um campo (em linha ou --file) é necessário.

Exemplo​
uip admin ip-restriction ip-ranges update a1b2c3d4-0000-0000-0000-000000000001 --name 'Home VPN'
uip admin ip-restriction ip-ranges update a1b2c3d4-0000-0000-0000-000000000001 --name 'Home VPN'
Formato dos dados (--output json)​
{ "Code": "ApmsIpRangeUpdated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Home VPN" } }
{ "Code": "ApmsIpRangeUpdated", "Data": { "id": "a1b2c3d4-0000-0000-0000-000000000001", "name": "Home VPN" } }

exclusão de ip-restrição-ip-intervalos do administrador uiip​

Argumentos​
NameRequiredFinalidade
[id]condicionalmenteUUID de entrada. Omita apenas quando --cidr for passado.
Opções​
LongValorRequiredDescription
--cidr <cidr>StringcondicionalmenteProcure a entrada a ser excluída por CIDR em vez de id.
--confirmBandeirasimReconhecer o risco de bloqueio. Omitir isso imprime o aviso de bloqueio e falha antes de qualquer pesquisa.
Exemplo​
uip admin ip-restriction ip-ranges delete a1b2c3d4-0000-0000-0000-000000000001 --confirm
uip admin ip-restriction ip-ranges delete a1b2c3d4-0000-0000-0000-000000000001 --confirm
Formato dos dados (--output json)​
{ "Code": "ApmsIpRangeDeleted", "Data": {} }
{ "Code": "ApmsIpRangeDeleted", "Data": {} }

aplicação de restrição de IP do administrador do uip​

Gerenciar o botão de alternância de aplicação de intervalo de IP único da organização. Quando ativado, apenas os IPs cobertos por ip-ranges list podem alcançar a organização; quando desativado, o padrão da plataforma se aplica.

aplicação de restrição de IP do administrador uip obter​

Exemplo​
uip admin ip-restriction enforcement get
uip admin ip-restriction enforcement get
Formato dos dados (--output json)​
{ "Code": "ApmsEnforcementGet", "Data": { "organizationId": "<org-guid>", "status": "Disabled" } }
{ "Code": "ApmsEnforcementGet", "Data": { "organizationId": "<org-guid>", "status": "Disabled" } }

aplicação de restrição de IP do administrador uip habilitar​

Opções​
LongValorRequiredDescription
--confirmBandeirasimReconhecer o risco de bloqueio. Sem ele, a CLI imprime o aviso e falha imediatamente, antes da verificação de simulação.

Simulação (executado após --confirm ser fornecido): chama my-ip e, em seguida, compara o resultado com cada CIDR de ip-ranges list. Se o IP do chamador não for coberto, o comando falhará com instruções para adicioná-lo primeiro — nenhuma chamada de rede para habilitar a aplicação é feita.

Exemplo​
uip admin ip-restriction enforcement enable --confirm
uip admin ip-restriction enforcement enable --confirm
Formato dos dados (--output json)​
{ "Code": "ApmsEnforcementEnabled", "Data": {} }
{ "Code": "ApmsEnforcementEnabled", "Data": {} }

desabilitar a aplicação da restrição de IP do administrador uip​

Idempotente — seguro de chamar quando já está desabilitado.

Exemplo​
uip admin ip-restriction enforcement disable
uip admin ip-restriction enforcement disable
Formato dos dados (--output json)​
{ "Code": "ApmsEnforcementDisabled", "Data": {} }
{ "Code": "ApmsEnforcementDisabled", "Data": {} }

uip admin-restrito-ignorar regras-ignoráveis​

Gerenciar exceções de padrão de URL para listas de permissões de IP — um desvio com escopo limitado para um padrão de URL específico de aplicativo/pasta/tenant quando a organização tem a aplicação ativada.

administrador uip-restrito-ignorar-rulelist de IP​

Opções​
LongValorDescription
--filter <fragment>StringFiltro de substring que não diferencia maiúsculas de minúsculas em regexEntry ou appName, aplicado no lado do cliente.
Exemplo​
uip admin ip-restriction bypass-rules list --filter contoso
uip admin ip-restriction bypass-rules list --filter contoso
Formato dos dados (--output json)​
{ "Code": "ApmsBypassRulesList", "Data": [{ "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" }] }
{ "Code": "ApmsBypassRulesList", "Data": [{ "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" }] }

uip admin ip-restrito strings obter​

Argumentos​
NameRequiredFinalidade
<id>simIgnorar o UUID da regra.
Exemplo​
uip admin ip-restriction bypass-rules get b1c2d3e4-0000-0000-0000-000000000001
uip admin ip-restriction bypass-rules get b1c2d3e4-0000-0000-0000-000000000001
Formato dos dados (--output json)​
{ "Code": "ApmsBypassRulesGet", "Data": { "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" } }
{ "Code": "ApmsBypassRulesGet", "Data": { "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" } }

uip admin ip-restrito bypass-rulees criar​

Opções​
LongValorRequiredDescription
--file <path>PathsimCorpo AddRegexBypassRequest JSON completo — não há formulário de sinalizador embutido para criar.
Exemplo​
uip admin ip-restriction bypass-rules create --file ./bypass-rule.json
uip admin ip-restriction bypass-rules create --file ./bypass-rule.json
Formato dos dados (--output json)​
{ "Code": "ApmsBypassRulesCreated", "Data": { "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" } }
{ "Code": "ApmsBypassRulesCreated", "Data": { "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" } }

atualização de regras de passagem de IP do administrador uip​

Argumentos​
NameRequiredFinalidade
<id>simIgnorar o UUID da regra.
Opções​
LongValorDescription
--regex-entry <pattern>StringPadrão de regex de substituição — o único campo de que o caso típico precisa. mutuamente exclusivo com --file.
--file <path>PathCorpo UpdateRegexBypassRequest completo, para o caso mais raro de atualização dos metadados do tenant/aplicativo. Mutualmente exclusivo com --regex-entry.

É necessário exatamente um dos --regex-entry ou --file.

Exemplo​
uip admin ip-restriction bypass-rules update b1c2d3e4-0000-0000-0000-000000000001 --regex-entry '^.*\.contoso\.com$'
uip admin ip-restriction bypass-rules update b1c2d3e4-0000-0000-0000-000000000001 --regex-entry '^.*\.contoso\.com$'
Formato dos dados (--output json)​
{ "Code": "ApmsBypassRulesUpdated", "Data": { "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" } }
{ "Code": "ApmsBypassRulesUpdated", "Data": { "id": "b1c2d3e4-0000-0000-0000-000000000001", "regexEntry": "^.*\\.contoso\\.com$" } }

uip admin ip-restrito bypass-rule Delete​

Argumentos​
NameRequiredFinalidade
<id>simIgnorar o UUID da regra.
Exemplo​
uip admin ip-restriction bypass-rules delete b1c2d3e4-0000-0000-0000-000000000001
uip admin ip-restriction bypass-rules delete b1c2d3e4-0000-0000-0000-000000000001
Formato dos dados (--output json)​
{ "Code": "ApmsBypassRulesDeleted", "Data": {} }
{ "Code": "ApmsBypassRulesDeleted", "Data": {} }

uip admin-restrição de IP meu-ip​

Mostrar o IP público que a UiPath Platform vê para o chamador atual — útil antes de ip-ranges create (para saber o que incluir na lista de permissões) e antes de enforcement enable (para confirmar que você está coberto).

Exemplo​

uip admin ip-restriction my-ip
uip admin ip-restriction my-ip

Formato dos dados (--output json)​

{ "Code": "ApmsMyIpGet", "Data": { "ipAddress": "<your-public-ip>" } }
{ "Code": "ApmsMyIpGet", "Data": { "ipAddress": "<your-public-ip>" } }

Veja também​

Esta página foi útil?

Conectar

Precisa de ajuda? Suporte

Quer aprender? Academia UiPath

Tem perguntas? Fórum do UiPath

Fique por dentro das novidades