IBM Cloud Docs
Plug-in da CLI de restrições baseadas em contexto

Plug-in da CLI de restrições baseadas em contexto

A IBM Cloud® interface de linha de comando (CLI) de restrições baseadas em contexto fornece recursos adicionais para restrições baseadas em contexto. É possível usar esse plug-in da CLI para gerenciar restrições de acesso para recursos do IBM Cloud® com base no local da rede de solicitações de acesso.

Antes de Iniciar

  • Instale a CLI do IBM Cloud. Para obter mais informações, consulte Introdução à CLI da IBM Cloud. O prefixo para executar comandos usando a CLI do IBM Cloud é ibmcloud.
  • Antes de executar os comandos, faça login em IBM Cloud com o comando ibmcloud login para gerar um token de acesso e autenticar sua sessão.

Instalando o plug-in de restrições baseadas em contexto

Para instalar o plug-in de restrições baseadas em contexto, execute o seguinte comando:

ibmcloud plugin install cbr

Na linha de comando, você é notificado quando há atualizações disponíveis para a CLI do ibmcloud e para o plug-in da CLI do cbr. Assegure-se de manter a sua CLI atualizada para que seja possível usar todos os comandos e sinalizações disponíveis.

Se você quiser ver a versão atual do plug-in cbr CLI, execute ibmcloud plugin list.

Zones

Operações em zonas de rede..

ibmcloud cbr zone-create

Esta operação cria uma zona de rede para a conta especificada

ibmcloud cbr zone-create [--name NAME] [--description DESCRIPTION] [--addresses ADDRESSES] [--vpc VPC] [--service-ref SERVICEREF] [--excluded EXCLUDED] [--empty-address-list] [--file FILE]

Exemplo

ibmcloud cbr zone-create --name example-zone --description "Example zone description" --addresses 192.0.2.1,3ffe:1900:fe21:4545::,192.2.3.5-192.2.3.10,3ffe:1900:fe21:4547::-3ffe:1900:fe21:6767:

ibmcloud cbr zone-create --name example-zone-with-service-ref --service-ref service_name=kms,location=us-south

ibmcloud cbr zone-create --name example-zone-with-vpc --vpc crn:v1:staging:public:is:us-south:a/12ab34cd56ef78ab90cd12ef34ab56cd::vpc:r123-abc456de-f789-abc1-23de-f456abc789ab

Exemplo

de saída

id                    9adc34f2867a43452a517b3c2de78b95   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::zone:9adc34f2867a43452a517b3c2de78b95   
address_count         7   
excluded_count        0   
name                  test   
account_id            0123456789   
description              
Addresses             1 IP Address, 1 IP Range, 1 Subnet, 2 VPCs, 2 Service References                                                                    
Excluded              No addresses       
href                  https://cbr.cloud.ibm.com/v1/zones/9adc34f2867a43452a517b3c2de78b95   
created_at            2024-03-06T22:20:25.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-06T22:20:25.000Z   
last_modified_by_id   iam-ServiceId-0123456789

Opções de comando

--name (string)
O nome da zona.
--description (string)
A descrição da zona.
--addresses (string)
A lista de endereços na zona. Somente endereços do tipo ipAddress, ipRange e subnet são permitidos em um formato delimitado por vírgulas. IPv4 e IPv6 são suportados.
--service-ref (string)
Os refs de serviço na zona Entrada no formulário service_name=VALUE,service_name=VALUE,...
Para localizar uma lista de refs de serviço disponíveis, execute o ibmcloud cbr service-ref-targets comando
--vpc (string)
Os VPCs permitidos na zona Entrada no formulário value,value,...
--excluded (string)
A lista de endereços excluídos na zona Somente endereços do tipo ipAddress, ipRange e subnet são permitidos em um formato delimitado por vírgulas.
--empty-address-list (bool)
Especifica explicitamente que a zona não terá endereços. Não pode ser usado em conjunto com os sinalizadores addresses, service-ref, vpc ou excluded.
--file (string)
O arquivo fornecido é usado para criar a zona. Essa sinalização é exclusiva e não pode ser usada com outras sinalizações. O arquivo precisa seguir o esquema JSON para a API de criação de zona Para obter mais informações, consulte a API de restrições baseadas em contexto.

ibmcloud cbr zones

Esta operação lista as zonas de rede na conta especificada

ibmcloud cbr zones [--name NAME] [--sort SORT]

Exemplo

ibmcloud cbr zones

Exemplo

de saída

id                                 name      address_count   excluded_count   
9adc34f2867a43452a517b3c2de78b95   test      7               0
12ab34cd56ef78ab90cd12ef34ab56cd   example   2               0

Opções de comando

--name (string)
O nome da zona.
--sort (string)
Classifica os resultados usando um campo de classificação válido Para saber mais, consulte Classificação..

ibmcloud cbr zone

Esta operação recupera a zona de rede identificada pelo ID da zona especificado.

ibmcloud cbr zone ZONE-ID

Exemplo

ibmcloud cbr zone 9adc34f2867a43452a517b3c2de78b95

Exemplo

de saída

id                    9adc34f2867a43452a517b3c2de78b95   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::zone:9adc34f2867a43452a517b3c2de78b95   
address_count         7   
excluded_count        0   
name                  test   
account_id            0123456789   
description              
Addresses             1 IP Address, 1 IP Range, 1 Subnet, 2 VPCs, 2 Service References                                                                    
Excluded              No addresses       
href                  https://cbr.cloud.ibm.com/v1/zones/9adc34f2867a43452a517b3c2de78b95   
created_at            2024-03-06T22:20:25.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-06T22:20:25.000Z   
last_modified_by_id   iam-ServiceId-0123456789

ibmcloud cbr zone-update

Essa operação substitui a zona de rede identificada pelo ID da zona especificado. As atualizações parciais não são suportadas e o objeto de zona de rede inteiro é substituído

ibmcloud cbr zone-update ZONE-ID [--name NAME] [--description DESCRIPTION] [--addresses ADDRESSES] [--vpc VPC] [--service-ref SERVICEREF] [--excluded EXCLUDED] [--empty-address-list] [--file FILE]

Exemplo

ibmcloud cbr zone-update 9adc34f2867a43452a517b3c2de78b95 --name 'Example Zone Name' --addresses 166.22.23.0-166.22.23.108,3ffe:1900:fe21:4545:: --excluded 166.22.23.100

ibmcloud cbr zone-update 9adc34f2867a43452a517b3c2de78b95 --name example-zone-with-service-ref --service-ref service_name=kms,location=us-south

ibmcloud cbr zone-update 9adc34f2867a43452a517b3c2de78b95 --name example-zone-with-vpc --vpc crn:v1:staging:public:is:us-south:a/12ab34cd56ef78ab90cd12ef34ab56cd::vpc:r123-abc456de-f789-abc1-23de-f456abc789ab

Exemplo

de saída

id                    9adc34f2867a43452a517b3c2de78b95   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::zone:9adc34f2867a43452a517b3c2de78b95   
address_count         7   
excluded_count        0   
name                  test update   
account_id            0123456789   
description              
Addresses             1 IP Address, 1 IP Range, 1 Subnet, 2 VPCs, 2 Service References                                                                    
Excluded              No addresses       
href                  https://cbr.cloud.ibm.com/v1/zones/9adc34f2867a43452a517b3c2de78b95   
created_at            2024-03-06T22:20:25.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-06T22:29:19.000Z   
last_modified_by_id   iam-ServiceId-0123456789

Opções de comando

--name (string)
O nome da zona.
--description (string)
A descrição da zona.
--addresses (string)
A lista de endereços na zona. Somente endereços do tipo ipAddress, ipRange e subnet são permitidos em um formato delimitado por vírgulas. IPv4 e IPv6 são suportados.
--service-ref (string)
Os refs de serviço na zona Entrada no formulário name=value,name=value,...
--vpc (string)
Os VPCs permitidos na zona Entrada no formulário value,value,...
--excluded (string)
A lista de endereços excluídos na zona Somente endereços do tipo ipAddress, ipRange e subnet são permitidos em um formato delimitado por vírgulas.
--empty-address-list (bool)
Especifica explicitamente que a zona não terá endereços. Não pode ser usado em conjunto com os sinalizadores addresses, service-ref, vpc ou excluded.
--file (string)
O arquivo fornecido é usado para atualizar a zona. Essa sinalização é exclusiva e não pode ser usada com outras sinalizações. O arquivo precisa seguir o esquema JSON para a API de atualização de zona Para obter mais informações, consulte a API de restrições baseadas em contexto.

ibmcloud cbr zone-patch

Esta operação executa uma atualização parcial da zona de rede identificada pelo ID de zona especificado.

ibmcloud cbr zone-patch ZONE-ID [--name NAME] [--description DESCRIPTION]

Exemplo

ibmcloud cbr zone-patch 9adc34f2867a43452a517b3c2de78b95 --name 'Example Zone Name' --description updated

Exemplo

de saída

id                    9adc34f2867a43452a517b3c2de78b95   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::zone:9adc34f2867a43452a517b3c2de78b95   
address_count         7   
excluded_count        0   
name                  test update   
account_id            0123456789   
description           updated   
Addresses             1 IP Address, 1 IP Range, 1 Subnet, 2 VPCs, 2 Service References                                                                    
Excluded              No addresses       
href                  https://cbr.cloud.ibm.com/v1/zones/9adc34f2867a43452a517b3c2de78b95   
created_at            2024-03-06T22:20:25.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-06T22:29:19.000Z   
last_modified_by_id   iam-ServiceId-0123456789

Opções de comando

--name (string)
O nome da zona.
--description (string)
A descrição da zona.

ibmcloud cbr zone-delete

Esta operação exclui a zona de rede identificada pelo ID da zona especificado.

ibmcloud cbr zone-delete ZONE-ID

Exemplo

ibmcloud cbr zone-delete 65810ac762004f22ac19f8f8edf70a34

ibmcloud cbr service-ref-targets

Esta operação lista todos os destinos de referência de serviço disponíveis

ibmcloud cbr service-ref-targets [--type TYPE]

Exemplo

ibmcloud cbr service-ref-targets

Exemplo

de saída

service_name                   service_type       locations   
ace                            -                  -   
apprapp                        -                  na, us, dal   
apprapp-dev                    -                  na, us, dal   
cloud-object-storage           -                  na, us, sjc   
cloudantnosqldb                -                  ap, au, syd, +27   
codeengine                     -                  ap, au, syd, +6   
compliance                     platform_service   na, us, dal, +1   
containers-kubernetes          -                  na, us, dal   
directlink                     -                  -   
event-notifications            -                  na, us, dal   
globalcatalog-collection       -                  -   
iam-groups                     platform_service   -   
is                             -                  eu, es, mad, +4   
kms                            -                  -   
logdna                         -                  ap, au, syd, +17   
logdnaat                       -                  ap, au, syd, +17   
messagehub                     -                  eu, uk, lon, +3   
messagehub-vnext-integration   -                  eu, uk, lon, +3   
schematics                     -                  eu, de, fra, +6   
secrets-manager                -                  -   
server-protect                 -                  eu, es, mad, +4   
sysdig-monitor                 -                  eu, uk, lon, +3   
sysdig-secure                  -                  eu, uk, lon, +3   
toolchain                      -                  ap, au, syd, +6   
user-management                platform_service   -

Opções de comando

--type (string)
Especifica os tipos de serviços a recuperar. O valor padrão é all. Os valores permitidos são: all, platform_service.

ibmcloud cbr service-ref-target

Esta operação obtém o destino de referência de serviço para um nome de serviço especificado

ibmcloud cbr service-ref-target SERVICE-NAME

Exemplo

ibmcloud cbr service-ref-target compliance

Exemplo

de saída

Service Name     compliance         
Service Type:    platform_service   
Locations:       
                 Name               Display Name    Kind   
                 na                 North America   geography   
                 us                 United States   country   
                 dal                Dallas          metro   
                 wdc                Washington DC   metro

Regras

Operações em regras de restrições baseadas em contexto

ibmcloud cbr rule-create

Esta operação cria uma regra para a conta especificada

ibmcloud cbr rule-create [--description DESCRIPTION] [--resource-attributes RESOURCES] [--context-attributes CONTEXTS] [--api-types API-TYPES] [--enforcement-mode ENFORCEMENT-MODE] [--service-name SERVICE-NAME] [--service-group-id SERVICE-GROUP-ID] [--service-instance SERVICE-INSTANCE] [--region REGION] [--resource-type RESOURCE-TYPE] [--resource RESOURCE] [--resource-group-id RESOURCE-GROUP-ID] [--tags TAGS] [--zone-id ZONE-ID] [--empty-context-list] [--file FILE]

Exemplo

ibmcloud cbr rule-create --description 'Example Rule Description' --service-name kms --context-attributes endpointType=private --zone-id 93de8d3f588ab2c457ff576c364d1145

ibmcloud cbr rule-create --service-name example-service --context-attributes mfa=LEVEL2,endpointType=public,networkZoneId=12ab34cd56ef78ab90cd12ef34ab56cd

Exemplo

de saída

id                    2c54cb0fefb0050c88f72d68c400fbec   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::rule:2c54cb0fefb0050c88f72d68c400fbec   
description           test   
operations            1 API Type   
contexts              1 Context   
resources                                  
                      serviceInstance   1234567891234   
                      serviceName       cloud-object-storage

href                  https://cbr.cloud.ibm.com/v1/rules/2c54cb0fefb0050c88f72d68c400fbec   
created_at            2024-03-07T15:36:52.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-07T15:36:52.000Z   
last_modified_by_id   iam-ServiceId-0123456789
enforcement_mode      enabled

Opções de comando

--description (string)
A descrição da regra.
--resource-attributes (string)
Os atributos de recurso aos qual esta regra se aplica na forma de name=value,name=value,...
--context-attributes (string)
Os atributos de contexto aos qual esta regra se aplica na forma de name=value,name=value,...
--api-types (string)
As APIs às quais uma regra se aplica. Para os tipos de API de serviço compatíveis, use o comando api-types no recurso.
--enforcement-mode (string)
Como a regra é aplicada. A CLI aceita os valores enabled (padrão), disabled e report. Para obter mais informações sobre aplicação, consulte Aplicação de regras.
--service-name (string)
Abreviação para criar o atributo de recurso IBM Cloud serviceName.
--service-group-id (string)
O atributo de recurso service_group_id..
--service-instance (string)
GUID da instância de serviço. Essa opção é exclusiva da opção --file.
--region (string)
Abreviação para criar o atributo de recurso IBM Cloud region. Para regiões compatíveis, execute ibmcloud regions.
--resource-type (string)
Abreviação para criar o atributo de recurso IBM Cloud resourceType.
--resource (string)
Abreviação para criar o atributo de recurso IBM Cloud resource.
--resource-group-id (string)
Abreviação para criar o atributo de recurso IBM Cloud resourceGroupId.
--tags (string)
As tags de acesso do recurso no formato name:value,name:value,....
--zone-id (string)
Abreviação para incluir o atributo de contexto networkZoneId no primeiro contexto
--empty-context-list (bool)
Especifica explicitamente que a regra não terá contextos. Isso não pode ser usado em conjunto com os sinalizadores context-attributes ou zone-id.
--file (string)
O arquivo fornecido é usado para criar a regra. Essa sinalização é exclusiva e não pode ser usada com outras sinalizações. O arquivo precisa seguir o esquema JSON para a API de criação de regras Para obter mais informações, consulte a API de restrições baseadas em contexto.

ibmcloud cbr rules

Esta operação lista as regras na conta especificada

ibmcloud cbr rules [--enforcement-mode ENFORCEMENT-MODE] [--service-name SERVICE-NAME] [--service-group-id SERVICE-GROUP-ID] [--service-instance SERVICE-INSTANCE] [--region REGION] [--resource-type RESOURCE-TYPE] [--resource RESOURCE] [--zone-id ZONE-ID] [--sort SORT]

Exemplo

ibmcloud cbr rules

Exemplo

de saída

id                                 service_name           enforcement   description   
2c54cb0fefb0050c88f72d68c400fbec   cloud-object-storage   enabled       test   
a4135a90bb507bf6d96cf4c6f009d151   kms                    disabled       example

Opções de comando

--enforcement-mode (string)
Como a regra é aplicada. A CLI aceita os valores enabled (padrão), disabled e report. Para obter mais informações sobre aplicação, consulte Aplicação de regras.
--region (string)
O atributo de recurso region..
--resource (string)
O atributo de recurso resource..
--resource-type (string)
O atributo de recurso resourceType..
--service-instance (string)
O GUID da instância do serviço.
--service-name (string)
O atributo de recurso serviceName..
--service-group-id (string)
O atributo de recurso service_group_id..
--zone-id (string)
A ID globalmente exclusiva da zona.
--sort (string)
Classifica os resultados usando um campo de classificação válido Para saber mais, consulte Classificação..

ibmcloud cbr rule

Essa operação recupera a regra identificada pelo ID de regra especificado.

ibmcloud cbr rule RULE-ID

Exemplo

ibmcloud cbr rule 30fd58c9b75f40e854b89c432318b4a2

Exemplo

de saída

id                    2c54cb0fefb0050c88f72d68c400fbec   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::rule:2c54cb0fefb0050c88f72d68c400fbec   
description           test   
operations            1 API Type   
contexts              1 Context   
resources                                  
                      serviceInstance   1234567891234   
                      serviceName       cloud-object-storage

href                  https://cbr.cloud.ibm.com/v1/rules/2c54cb0fefb0050c88f72d68c400fbec   
created_at            2024-03-07T15:36:52.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-07T15:36:52.000Z   
last_modified_by_id   iam-ServiceId-0123456789
enforcement_mode      enabled

ibmcloud cbr rule-update

Essa operação substitui a regra identificada pelo ID da regra especificado. As atualizações parciais não são suportadas e o objeto de regra inteiro é substituído

ibmcloud cbr rule-update RULE-ID [--description DESCRIPTION] [--resource-attributes RESOURCES] [--context-attributes CONTEXTS] [--api-types API-TYPES] [--enforcement-mode ENFORCEMENT-MODE] [--service-name SERVICE-NAME] [--service-instance SERVICE-INSTANCE] [--region REGION] [--resource-type RESOURCE-TYPE] [--resource RESOURCE] [--resource-group-id RESOURCE-GROUP-ID] [--tags TAGS] [--zone-id ZONE-ID] [--empty-context-list] [--file FILE]

Exemplo

ibmcloud cbr rule-update 30fd58c9b75f40e854b89c432318b4a2 --description 'Example rule description' --service-name kms --context-attributes endpointType=private --zone-id 93de8d3f588ab2c457ff576c364d1145

Exemplo

de saída

id                    2c54cb0fefb0050c88f72d68c400fbec   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::rule:2c54cb0fefb0050c88f72d68c400fbec   
description           updated   
operations            1 API Type   
contexts              1 Context   
resources                                  
                      serviceInstance   1234567891234   
                      serviceName       cloud-object-storage

href                  https://cbr.cloud.ibm.com/v1/rules/2c54cb0fefb0050c88f72d68c400fbec   
created_at            2024-03-07T15:36:52.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-07T15:41:18.000Z   
last_modified_by_id   iam-ServiceId-0123456789
enforcement_mode      enabled

Opções de comando

--description (string)
A descrição da regra.
--resource-attributes (string)
Os atributos de recurso aos qual esta regra se aplica na forma de name=value,name=value,...
--context-attributes (string)
Os atributos de contexto aos qual esta regra se aplica na forma de name=value,name=value,...
--api-types (string)
As APIs às quais uma regra se aplica. Para os tipos de API de serviço compatíveis, use o comando api-types no recurso.
--enforcement-mode (string)
Como a regra é aplicada. A CLI aceita os valores enabled (padrão), disabled e report. Para obter mais informações sobre aplicação, consulte Aplicação de regras.
--service-name (string)
Abreviação para criar o atributo de recurso IBM Cloud serviceName.
--service-group-id (string)
O atributo de recurso service_group_id..
--service-instance (string)
GUID da instância de serviço. Essa opção é exclusiva da opção --file.
--region (string)
Abreviação para criar o atributo de recurso IBM Cloud region. Para regiões compatíveis, execute ibmcloud regions.
--resource-type (string)
Abreviação para criar o atributo de recurso IBM Cloud resourceType.
--resource (string)
Abreviação para criar o atributo de recurso IBM Cloud resource.
--resource-group-id (string)
Abreviação para criar o atributo de recurso IBM Cloud resourceGroupId.
--tags (string)
As tags de acesso do recurso no formato name:value,name:value,....
--zone-id (string)
Abreviação para incluir o atributo de contexto networkZoneId no primeiro contexto
--empty-context-list (bool)
Especifica explicitamente que a regra não terá contextos. Isso não pode ser usado em conjunto com os sinalizadores context-attributes ou zone-id.
--file (string)
O arquivo fornecido é usado para atualizar a regra. Essa sinalização é exclusiva e não pode ser usada com outras sinalizações. O arquivo precisa seguir o esquema JSON para a API de atualização de regras. Para obter mais informações, consulte a API de restrições baseadas em contexto.
O arquivo fornecido é usado para criar a regra. Essa sinalização é exclusiva e não pode ser usada com outras sinalizações. O arquivo precisa seguir o esquema JSON para a API de criação de regras Para obter mais informações, consulte a API de restrições baseadas em contexto.

ibmcloud cbr rule-patch

Essa operação executa uma atualização parcial da regra identificada pelo ID de regra especificado.

ibmcloud cbr rule-patch RULE-ID [--description DESCRIPTION] [--enforcement-mode ENFORCEMENT-MODE]

Exemplo

ibmcloud cbr rule-patch 30fd58c9b75f40e854b89c432318b4a2 --description 'Example rule description' --enforcement-mode disabled

Exemplo

de saída

id                    2c54cb0fefb0050c88f72d68c400fbec   
crn                   crn:v1:bluemix:public:cbr:global:a/0123456789::rule:2c54cb0fefb0050c88f72d68c400fbec   
description           updated   
operations            1 API Type   
contexts              1 Context   
resources                                  
                      serviceInstance   1234567891234   
                      serviceName       cloud-object-storage

href                  https://cbr.cloud.ibm.com/v1/rules/2c54cb0fefb0050c88f72d68c400fbec   
created_at            2024-03-07T15:36:52.000Z   
created_by_id         iam-ServiceId-0123456789
last_modified_at      2024-03-07T15:41:18.000Z   
last_modified_by_id   iam-ServiceId-0123456789
enforcement_mode      enabled

Opções de comando

--description (string)
A descrição da regra.
--enforcement-mode (string)
Como a regra é aplicada. A CLI aceita os valores enabled (padrão), disabled e report. Para obter mais informações sobre aplicação, consulte Aplicação de regras.

ibmcloud cbr rule-delete

Esta operação exclui a regra identificada pelo ID de regra especificado.

ibmcloud cbr rule-delete RULE-ID

Exemplo

ibmcloud cbr rule-delete 30fd58c9b75f40e854b89c432318b4a2