Using the service commands

You can use the service commands to check and list the Developer Portal service from the Developer Portal database.

  1. Log in as Cloud manager:
    apic login --server management_server --realm admin/identity_provider --username cloud_username --password cloud_password
    You can determine which identity provider to use in the --realm parameter by entering the following command to see a list of all available identity providers (you do not need to be logged in to use this command):
    apic identity-providers:list --scope admin --server mgmt_endpoint_url --fields title,realm
    For example:
    apic identity-providers:list --scope admin --server --fields title,realm
    total_results: 2
      - title: Cloud Manager User Registry
        realm: admin/default-idp-1
      - title: Corporate LDAP user registry
        realm: admin/corporate-ldap
    The title value should enable you to determine which identity provider to use; you can then copy the corresponding --realm parameter directly from the displayed realm value. For any identity providers that were created by your administrator after API Connect was installed, the names will have been determined at creation time. The default Cloud Manager Local User Registry for login as a member of the cloud administration organization is default-idp-1.

    For full details of the apic login command, see Logging in to a management server.

    For a summary of the general-purpose commands and their use, see Developer Portal CLI commands.

  2. Get the availability zone of the portal service's sites that you want to list.
    apic availability-zones --org orgid/name --server management_server
    • apic service:list - List the Portal service currently installed.
    • -s, --server mgmt_endpoint_url. Use the value of the platform API endpoint URL for this entry.
    • --org orgid
    • --catalog catalog id.
    • --debug. If you need debug information.
  3. List the installed Developer Portal service.
    apic --mode portaladmin service:list -s management_server --portal_service_name PORTAL-SERVICE-NAME --format json