vania-janet/multiturn-rag-retrieval-data huggingface dataset:
Administering connected queue managers using the REST API gateway 



 What is Remote Administration using the REST API 

IBM® MQ allows you to administer IBM® MQ objects, such as queue managers and queues using the administrative REST API. Information is sent to, and received from, the administrative REST API in JSON format. These RESTful APIs can help you to embed IBM MQ administration into popular DevOps and automation tooling.

This tutorial will cover the following :



1. We will create two MQ on cloud queue managers, first queue manager will act as a gateway queue manager and the second queue manager will act as a remote queue manager.
2. Configure the MQ on cloud gateway queue manager(s) to administer remote queue managers. That is, we will configure transmission queues, listeners, and sender and receiver channels between the gateway queue manager and remote queue manager.
3. We will send a REST request to the remote queue manager by specifying the queue manager name in the resource URL, the gateway queue manager is specified in a header that is sent with the request.



The request is sent through the gateway queue manager to the remote queue manager. On successful submission of request, a response is returned with a header that indicates the queue manager that was used as the gateway queue manager.

--------------------





 Prerequisites 

To use the administrative REST API gateway to administer remote queue managers, we will prepare the queue managers for remote administration. The gateway queue manager is then specified by setting the ibm-mq-rest-gateway-qmgr attribute in a header that is sent with the request. The request is sent through the gateway queue manager to the remote queue manager. The response is returned with a header that indicates the queue manager that was used as the gateway queue manager.

In order to proceed with this tutorial, it is vital that you have completed the following prerequisites:



1. Create two IBM MQ on Cloud queue manager
* -q, --quiet: Suppress verbose output.



--------------------







 ibmcloud is bare-metal-server-console 

Open an interactive console to the bare metal server. By default, this command opens an interactive serial console.

ibmcloud is bare-metal-server-console SERVER [--vnc] [-q, --quiet]



 Command options 



* SERVER: ID or name of the server.
* --vnc: Get the WebSocket URI for the VNC console, it doesn't open the VNC console.
* -q, --quiet: Suppress verbose output.



--------------------







 ibmcloud is bare-metal-server-create 

Create a bare metal server.

ibmcloud is bare-metal-server-create --zone ZONE_NAME --profile PROFILE --image IMAGE --keys KEYS ((--pnic-subnet PRIMARY_NIC_SUBNET [--vpc VPC]) [--pnic-name PRIMARY_NIC_NAME] [--pnic-rip PNIC_RIP | (--pnic-rip-address PNIC_RIP_ADDRESS --pnic-rip-auto-delete true | false --pnic-rip-name PNIC_RIP_NAME)] [--pnic-sgs PNIC_SGS] [--pnic-allowed-vlans PNIC_ALLOWED_VLANS] [--pnic-ein true | false] [--pnic-ais false | true]) [--name NAME] [--user-data DATA] [--network-interfaces NETWORK_INTERFACES_JSON | @NETWORK_INTERFACES_JSON_FILE] [--enable-secure-boot false | true] [--tpm-mode tpm_2 | disabled] [--resource-group-id RESOURCE_GROUP_ID | --resource-group-name RESOURCE_GROUP_NAME] [-i, --interactive] [--output JSON] [-q, --quiet]



 Command examples
Use the API key you created with the IAM identity token API to generate an IAM token. For example:

curl -X POST 'https://iam.cloud.ibm.com/identity/token' -H 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=urn:ibm:params:oauth:grant-type:apikey&apikey=<your iam api key>'

For details on the API syntax, see [IAM identity token API](https://cloud.ibm.com/apidocs/iam-identity-token-apicreate-an-iam-access-token-for-a-user-or-service-i).

This is a sample of what is returned:

{
"access_token": "eyJraWQiOiIyMDE3MDgwOS0wMDowMDowMCIsImFsZyI6…",
"refresh_token": "zmRTQFKhASUdF76Av6IUzi9dtB7ip8F2XV5fNgoRQ0mbQgD5XCeWkQhjlJ1dZi8K…",
"token_type": "Bearer",
"expires_in": 3600,
"expiration": 1505865282
}
4. Use the value of the access_token property for your IBM Analytics Engine API calls. Set the access_token value as the authorization header parameter for requests to the IBM Analytics Engine APIs. The format is Authorization: Bearer <access_token_value>.

For example:

Authorization: Bearer eyJraWQiOiIyMDE3MDgwOS0wMDowMDowMCIsImFsZyI6IlJTMjU2In0...







 Create a token using the IBM Cloud CLI 

Before you can create a token by using the IBM Cloud CLI, check that you have met the following prerequisites:



1. You have a valid IBMid.
2.
Configuring the authentication method of a Monitoring instance 

You can configure the authentication token that is allowed in a Monitoring instance when you use Python scripts or the Monitoring REST API to manage resources. By default, you can use an IAM token or a Monitor API token . However, you can restrict the Monitoring instance to only allow IAM tokens.



 Prereqs 

Complete the following steps:



1. [Install the IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli). If the CLI is installed, continue with the next step.
2. Log in to the region and resource group in the IBM Cloud where the Monitoring instance is available. Run the following command: [ibmcloud login](https://cloud.ibm.com/docs/cli?topic=cli-ibmcloud_cliibmcloud_login)







 Step 1. Get information on the Monitoring instance 

To get information about the Monitoring instance, run the following command:

ibmcloud resource service-instance MONITORING_INSTANCE_NAME --output JSON

The output includes a parameters section with the following information:

"parameters": {
"default_receiver": false,
"external_api_auth": "IAM_ONLY"
}

The external_api_auth field indicates the types of tokens that are allowed to work with the Monitoring instance.



* When the value is set to IAM_ONLY, you can only use IAM tokens to authenticate.
* When the value is set to ANY, you can use IAM tokens and Monitor API tokens to authenticate.



Check the external_api_auth to find out what tokens are allowed for authentication.





 Step 2. Reset the Monitor API token for each team 

Complete this step if you are configuring your monitoring instance to authenticate with IAM tokens only.

When you reset a Monitor API token , you disable the current Monitor API token that users might be using. There is 1 Monitor API token per team.
Log in as the functional ID.

ibmcloud login
4. Target the resource group where you want to set the API key. If you don't target a resource group, the API key is set for the default resource group. To list available resource groups, run ibmcloud resource groups.

ibmcloud target -g <resource_group_name>
5. Create an API key that impersonates your infrastructure permissions. Red Hat OpenShift on IBM Cloud uses this API key to authenticate requests to manage infrastructure in the region and resource group. The previous API key for the region and resource group, if any, is deleted.

ibmcloud oc api-key reset --region <region>
6. Verify that the API key is set up.

ibmcloud oc api-key info --cluster <cluster_name_or_ID>
7. Repeat these steps for each region and resource group that you want to create clusters in.



Now that the API key is set up for the region and resource group, you can [assign users IBM Cloud IAM platform access roles](https://cloud.ibm.com/docs/openshift?topic=openshift-userschecking-perms) to restrict what cluster infrastructure actions they can perform.





 Understanding other options than the API key 

For different ways to access the IBM Cloud infrastructure portfolio, check out the following sections.



* If you aren't sure whether your account already has access to the IBM Cloud infrastructure portfolio, see [Understanding access to the infrastructure portfolio](https://cloud.ibm.com/docs/openshift?topic=openshift-access-credsunderstand_infra).
* If the account owner does not set the API key, [ensure that the user who sets the API key has the correct permissions](https://cloud.ibm.com/docs/openshift?topic=openshift-access-credsowner_permissions).
If you use the pitch_percentage parameter and also use the pitch attribute of the <prosody> tag to modify the pitch for specific text of the same request, the effects are multiplicative. For example, suppose you specify the pitch_percentage parameter with a value of 10, which increases the pitch by 10 percent. If you also use the <prosody> element to specify an equivalent pitch of +10% for specific text of the request, that text is spoken with a pitch that is 121 percent of the default baseline pitch for the voice.





 Speaking pitch examples 

The following HTTP POST /v1/synthesize method uses the pitch_percentage query parameter with a value of 5. The resulting audio is spoken with a pitch that is five percent higher than it is by default. The example uses the US English voice en-US_AllisonV3Voice.

IBM Cloud

curl -X POST -u "apikey:{apikey}" --header "Content-Type: application/json" --header "Accept: audio/wav" --output pitch-percentage.wav --data "{"text":"This text is spoken five percent higher than the default."}" "{url}/v1/synthesize?voice=en-US_AllisonV3Voice&pitch_percentage=5"

IBM Cloud Pak for Data

curl -X POST --header "Authorization: Bearer {token}" --header "Content-Type: application/json" --header "Accept: audio/wav" --output pitch-percentage.wav --data "{"text":"This text is spoken five percent higher than the default."}" "{url}/v1/synthesize?voice=en-US_AllisonV3Voice&pitch_percentage=5"

The following WebSocket example shows inclusion of the parameter with the same value on the request to establish a connection:

var access_token = '{access_token}';
var wsURI = '{ws_url}/v1/synthesize'
+ '?access_token=' + access_token
+ '&voice=en-US_AllisonV3Voice'
[Check mark](https://cloud.ibm.com/docs-content/v1/content/4cd6263f39a034d265ddb4b0a5e6d50c55d13ee8/ibm-cloud-provider-for-terraform/images/checkmark.svg) <br>For multi-zone regions only 







 Supported input parameters 

Review what parameters you can set in the provider block of your Terraform on IBM Cloud configuration file. For more information, about the IBM Cloud provider input parameters, see [IBM Cloud](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docsargument-reference).



Supported input parameters in configuration file

 Input parameter Required / optional Description 

 iaas_classic_api_key Required for classic infrastructure The API key to access classic IBM Cloud infrastructure. For more information, about how to retrieve your API key, see [Managing classic infrastructure API keys](https://cloud.ibm.com/docs/account?topic=account-classic_keys). This value is required when you want to work with classic infrastructure resources. You can specify the API key in the provider block or retrieve the value from the IAAS_CLASSIC_API_KEY environment variable. 
 iaas_classic_username Required for classic infrastructure The user name to access classic IBM Cloud infrastructure. For more information, about how to retrieve your user name, see [Managing classic infrastructure API keys](https://cloud.ibm.com/docs/account?topic=account-classic_keys). This value is required when you want to work with classic infrastructure resources. You can specify the user name in the provider block or retrieve the value from the IAAS_CLASSIC_USERNAME environment variable. 
 iaas_classic_endpoint_url Optional The API endpoint that you want to use to access IBM Cloud classic infrastructure. If this value is not specified, https://api.softlayer.com/rest/v3 is used by default. You can specify the URL in the provider block or retrieve the value from the IAAS_CLASSIC_ENDPOINT_URL.
* CLI
* API







 Troubleshooting your VPC 

This document covers common difficulties you might encounter, and offers some helpful tips.



 Using DEBUG mode or verbose mode when using the API 

For example, you can add --verbose to your curl command and send us the X-Request-Id: value so we can troubleshoot the problem. The --verbose flag is particularly helpful if you are experiencing connectivity problems.

Another option is to add the -i flag to your curl command so that the support team can see the headers in the response of your request. This flag is helpful in most situations when you need to contact support.





 API calls require a Bearer token 

When you use the API with a cURL command, you might need to include "Bearer" in the Authorization header, depending on what is in the $iam_token. If it includes the word "Bearer", you don't include it again in the header. Most examples assume that "Bearer" is included in the header.





 Turning on TRACE mode when using the CLI 

To turn on TRACE (debug) mode when you use the CLI, set IBMCLOUD_TRACE=true before the CLI command.

For example:

IBMCLOUD_TRACE=true ibmcloud is pubgws





 Using a different endpoint for CLI 

To change the VPC API endpoint that the IBM Cloud® CLI uses by default, set the environment variable IBMCLOUD_IS_API_ENDPOINT before you use the CLI. For example,

export IBMCLOUD_IS_API_ENDPOINT=api.dev.domain.com





 Common problems 

Here are a few difficulties you might encounter.



 Not authorized (401 or 403 error) 

Your account might not be authorized for VPC. Make sure that you are using an account that has been onboarded.





 IAM token expired 

The service is no longer returning any JSON, instead of just giving an HTTP "401 Unauthorized" to all requests. This error occurs after about an hour if your IAM token has expired.
For more information, see [Migrating the Activity Tracker Event Routing account configuration from V1 to V2](https://cloud.ibm.com/docs/atracker?topic=atracker-migration&interface=cli).

For more in formation, see [Collecting events](https://cloud.ibm.com/docs/atracker?topic=atracker-events_collect&interface=cli).





 What are the API V2 enhancements? 

The following table outlines key feature differences between Activity Tracker Event Routing API versions:



Table 1. Activity Tracker Event Routing API version feature comparison

 Feature comparison API Version 2 API Version 1 (deprecated) 

 Each region is managed separately. ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/bcd8b79ca2ed73bfcaefb20051f12cb6400286ab/atracker/images/checkmark-icon.svg) 
 The account configuration is managed in a user-specified location. ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/bcd8b79ca2ed73bfcaefb20051f12cb6400286ab/atracker/images/checkmark-icon.svg) 
 You can restrict the location where targets are defined in the account. ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/bcd8b79ca2ed73bfcaefb20051f12cb6400286ab/atracker/images/checkmark-icon.svg) 
 You can configure 1 or more default targets for events not explicitly managed in the account's routing rules. ![Checkmark icon](https://cloud.ibm.com/docs-content/v1/content/bcd8b79ca2ed73bfcaefb20051f12cb6400286ab/atracker/images/checkmark-icon.svg)
(https://cloud.ibm.com/docs/schematics?topic=schematics-secure-datapi-location)
* How can I use (IBM) GitLab repositories?

Yes, You can access the private (IBM) GitLab repository by using Schematics with the privileges.



* If the private (IBM) GitLab repository git.cloud.ibm.com access token is not needed as the IAM token is used.
* If the public GitLab gitlab.com, read_repository, and read_api access are needed to validate the branch name for private repository.



You can use the sample Terraform code block to configure the GitLab repository details.

"template_repo": {
"url": "<gitlab_source_repo_url>",
"branch": ""
},
* Can IAM access groups be managed in Schematics?

Yes, Schematics supports the full IBM Cloud provider resource set. For more information about How IAM access group works? see [ibm_iam_access_group](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/iam_access_group).
* How do I work with resources in another account?

Yes, you can create Schematics Workspaces in IBM Cloud source account. Then, run Terraform providing resources in target account to provision, through CLI, and API calls by using the target account service ID with the authentication, appropriate cross account authorization, or API key. For more information, see [Managing resources in other account](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-configmanage-resource-account).
* What does North America location indicate?

North America always indicates both us-south, and us-east location during the Schematics Workspaces creation. For more information, see [Where can I create Schematics Workspaces?]
For more information, see this [FAQ](https://cloud.ibm.com/docs/vpc?topic=vpc-faqs-for-rmdsfaq-rmds-4).

The metadata service is disabled by default. You can enable it for new and existing instances in the UI, CLI, or API.





 How do I enable the metadata service? Can I later disable it? 

The metadata service is disabled by default. You can enable it on new and existing instances from the UI, CLI, or API. For more information, see [Enable or disable the instance metadata service](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-configure-service&interface=cliimd-metadata-service-enable).

For this release, for instances created with metadata services disabled at time of creation and later updated to enable the metadata service, you must stop and restart the instance to fully enable the metadata service.





 What information can I get from the metadata service? 

The metadata service provides information about your running virtual server instance: instance initialization data, network interface, volume attachment, public SSH key, and placement group information. For a complete list of all information provided, see [Summary of data returned by the metadata service](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-metadata-summary).





 What is the instance identity token service? 

The instance identity token service lets you generate an instance identity access token that provides a security credential for accessing the metadata. To interact with the instance identity token service, you make a REST API call to the service using a well-known, non-routable IP address. You access the token from within the instance. For more information, see [Instance identity token service](https://cloud.ibm.com/docs/vpc?topic=vpc-imd-aboutimd-vpc-access-token).

You can also generate an IAM token from the instance identity access token, and then use the IAM token to access all IAM-enabled services.
* If the public GitLab gitlab.com, read_repository, and read_api access are needed to validate the branch name for private repository.



You can use the sample Terraform code block to configure the GitLab repository details.

"template_repo": {
"url": "<gitlab_source_repo_url>",
"branch": ""
},





 Can IAM access groups be managed in Schematics? 

Yes, Schematics supports the full IBM Cloud provider resource set. For more information about How IAM access group works? see [ibm_iam_access_group](https://registry.terraform.io/providers/IBM-Cloud/ibm/latest/docs/resources/iam_access_group).





 How do I work with resources in another account? 

Yes, you can create Schematics Workspaces in IBM Cloud source account. Then, run Terraform providing resources in target account to provision, through CLI, and API calls by using the target account service ID with the authentication, appropriate cross account authorization, or API key. For more information, see [Managing resources in other account](https://cloud.ibm.com/docs/schematics?topic=schematics-create-tf-configmanage-resource-account).





 What does North America location indicate? 

North America always indicates both us-south, and us-east location during the Schematics Workspaces creation. For more information, see [Where can I create Schematics Workspaces?](https://cloud.ibm.com/docs/schematics?topic=schematics-locationswhere-wks-created), and [Where is my information stored?](https://cloud.ibm.com/docs/schematics?topic=schematics-secure-datapi-location)





 What ports and IP addresses are used by Schematics? 

Schematics communicates with the ports that are specified by the related resources.
Configure an HTTPS back-end pool.
3. Add your back-end member instance to the HTTPS back-end pool. Ensure that your back-end member instances are configured to handle HTTPS traffic.
4. Configure health check with type HTTPS to perform encrypted health checks with your back-end members.



An application load balancer does not verify the SSL certificates of the back-end member instances.





 Horizontal scaling 

An application load balancer adjusts its capacity automatically according to the load. When this adjustment occurs, you might see a change in the number of IP addresses associated with the load balancer's DNS name.





 MZR support 

IBM Cloud Application Load Balancer for VPC supports Multi-Zone-Regions (MZRs). You can achieve high availability and redundancy by deploying an application load balancer with subnets from different zones. When subnets from multiple zones are used to provision an application load balancer, the load balancer appliances get deployed to multiple zones.





 Integration with instance groups 

IBM Cloud Application Load Balancer for VPC integrates with instance groups, which can auto scale your back-end members. Pool members are dynamically added and deleted based on your usage and requirements.





 Datapath log forwarding 

With datapath logging enabled, load balancer logs are forwarded to the [IBM Log Analysis](https://cloud.ibm.com/catalog/services/ibm-log-analysis) service, where you can view your datapath logs.





 HTTP2 support 

Application load balancers support end-to-end HTTP2 traffic, and works with listener protocols set as either HTTPS or TCP.





 WebSocket support 

WebSocket provides full-duplex communication channels over a single TCP connection. Application load balancers support WebSocket with every type of listener protocol (HTTP/HTTPS/TCP).





 Architecture 

The following diagram illustrates the deployment architecture for the ALB.

Zoom

!
* body_cells: An array of cells that are not table header or column header or row header cells, of the current table with corresponding row and column header associations. Each body cell is defined as a collection of the following items:



* cell_id: The unique ID of the cell in the current table.
* location: The location of the cell in the input document as defined by its begin and end indexes.
* text: The textual contents of the cell from the input document without associated markup content.
* row_index_begin: The begin index of this cell's row location in the current table.
* row_index_end: The end index of this cell's row location in the current table.
* column_index_begin: The begin index of this cell's column location in the current table.
* column_index_end: The end index of this cell's column location in the current table.
* row_header_ids: An array of values, each being the cell_id value of a row header that is applicable to this body cell.
* row_header_texts: An array of values, each being the text value of a row header that is applicable to this body cell.
* row_header_texts_normalized: If you provide customization input, the normalized version of the row header texts according to the customization; otherwise, the same value as row_header_texts.
* column_header_ids: An array of values, each being the cell_id value of a column header that is applicable to this body cell.
* column_header_texts: An array of values, each being the text value of a column header that is applicable to this body cell.
* column_header_texts_normalized: If you provide customization input, the normalized version of the column header texts according to the customization; otherwise, the same value as column_header_texts.
* attributes: An array that identifies document attributes. Each object in the array consists of three elements:



* type: The type of attribute. Possible values are Address, Currency, DateTime, Duration, Location, Number, Organization, Percentage, and Person.
* text: The text that is associated with the attribute.