Using the queue commands

You can use the queue commands to list the queued and locked platform tasks on your Developer Portal site.

  1. List the queued and locked platform tasks for a specific Developer Portal site, including Developer Portal creates, restores, upgrades, snapshots, and cron jobs. An empty response means that there are currently no queued tasks for this Developer Portal.
    1. Log in as Provider org as seen in the following example.
      apic login --server management_server --realm provider/identity_provider --username provider_username --password provider_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 provider --server platform_api_endpoint_url --fields title,realm
      For example,
      apic identity-providers:list --scope provider --server platform_api_endpoint_url --fields title,realm 
      total_results: 2
      results:
        - title: API Manager User Registry
          realm: provider/default-idp-2
        - title: Corporate LDAP user registry
          realm: provider/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 API Manager Local User Registry for login as a member of a provider organization is default-idp-2.

      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. Run the following queue:get command:
      apic --mode portaladmin queue:get --server management_server  --org orgid/name --catalog catalogid/name
      • management_server is the endpoint URL of the management server (required).
      • orgid/name is the ID or name of the provider organization that the catalog belongs to (required).
      • catalogid/name is the ID or name of the catalog that the site belongs to (required).
  2. List the queued and locked platform related tasks for all of the Developer Portal sites on a specific portal service, including Developer Portal creates, restores, upgrades, snapshots, and cron jobs. An empty response means that there are currently no queued tasks.
    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 myserver.com --fields title,realm
      total_results: 2
      results:
        - 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.
    2. Run the following queue:list command:
      apic --mode portaladmin queue:list --server management_server  --portal_service_name  portal_service_name
      • portal_service_name is the name of the portal service (required).