Skip to content

Latest commit

 

History

History
142 lines (115 loc) · 4.34 KB

service-connection.md

File metadata and controls

142 lines (115 loc) · 4.34 KB
Raw
copyright lastupdated keywords subcollection
years
2020
2020-12-17
isolation for IBM Cloud CLI, service endpoints for IBM Cloud CLI, private network for IBM Cloud CLI, network isolation in IBM Cloud CLI, non-public routes for IBM Cloud CLI, private connection for IBM Cloud CLI, private endpoints, regions that support private endpoints, private service endpoints
cli

{:external: target="_blank" .external} {:shortdesc: .shortdesc} {:screen: .screen} {:pre: .pre} {:table: .aria-labeledby="caption"} {:codeblock: .codeblock} {:note: .note} {:tip: .tip}

Securing your connection when using the {{site.data.keyword.cloud_notm}} CLI

{: #service-connection}

To ensure that you have enhanced control and security over your data when you use the {{site.data.keyword.cloud}} Command Line Interface, you have the option of using private routes to {{site.data.keyword.cloud_notm}} endpoints. Private routes are not accessible or reachable over the internet. By using the {{site.data.keyword.cloud_notm}} private endpoints feature, you can protect your data from threats from the public network and logically extend your private network. {: shortdesc}

The CLI leverages the private endpoint support that is provided by the {{site.data.keyword.cloud_notm}} platform. Platform services that are used by the core CLI, such as IAM, provide private endpoint support.

Regional support is provided for a limited number of CLI commands. The following regions support private endpoints:

  • us-south
  • us-east

Enabling virtual routing and forwarding

{: #cli-private-vrf}

You must first enable virtual routing and forwarding in your account, and then you can enable the use of {{site.data.keyword.cloud_notm}} private service endpoints. For more information about setting up your account to support the private connectivity option, see Enabling VRF and service endpoints.

To learn more about private connections on {{site.data.keyword.cloud_notm}}, see Secure access to services using service endpoints.

Logging in to the CLI with a private endpoint

{: #cli-private-login}

Use the following command to log in to a private endpoint by using the CLI:

ibmcloud login -a private.cloud.ibm.com

Targeting a supported region

{: #cli-private-region}

A region must be targeted when a private endpoint is set in the {{site.data.keyword.cloud_notm}} CLI.

Use the following command to target a supported region:

ibmcloud target -r [region]

Determining which CLI plug-ins support private endpoints

{: #cli-private-plugins}

The plugin list command reports whether an installed CLI plug-in supports private endpoints. If a plug-in that you use does not show private support, you must continue to use it with your API set to the public endpoint cloud.ibm.com.

Determining which commands support private endpoints

{: #cli-private-commands}

The following commands support private endpoints:

  • api
  • login
  • target
  • logout

Most commands under the following namespaces work when you are using private endpoints:

  • account
  • billing
  • iam
  • resource
  • catalog

If the CLI is set to access private endpoints and you try to run a command or plug-in that does not yet support private endpoints, you might see an error. {: note}

The following core commands do not yet support private endpoints:

resource
	cf-service-instance-migrate
	service-alias
  	service-alias-create
  	service-alias-delete
  	service-alias-update
  	service-aliases
  	service-binding
  	service-binding-create
  	service-binding-delete
  	service-bindings
account
  domain-cert
	domain-cert-add
  domain-cert-remove
  org
  org-account
  org-create
  org-rename
  org-replicate
  org-role-set
 	org-role-unset
  org-roles
  org-user-add
  org-user-remove
  org-users
  orgs
  space
  space-create
  space-delete
  space-rename
  space-role-set
  space-role-unset
  space-roles
  space-users
  spaces
    audit-logs
    update
iam
  dedicated-id-disconnect 
billing
  org-usage
catalog
  template-run
dev
  all commands
cf
  all commands
sl
  all commands
app (deprecated)
  all commands
service (deprecated)
  all commands