IBM Aspera Orchestrator

https://www.ibm.com/docs/en/aspera-orchestrator
Admin
IBM Aspera Orchestrator is a workflow automation platform designed to manage and automate high-speed...
Tokens:424,965
Snippets:2,742
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### Run Orchestrator Setup with asctl

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orchestrator-setup

The 'asctl orchestrator:setup' command initiates the installation and interactive setup process for IBM Aspera Orchestrator. It requires no initial inputs but prompts the user with questions to configure the Orchestrator, displaying entered information before starting the installation.

```bash
asctl orchestrator:setup
```

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

### Configure and Start Orchestrator

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=installation-install-orchestrator

Sets up and starts the IBM Aspera Orchestrator service. This involves running the 'orchestrator setup' command to configure database connections and other settings, followed by 'orchestrator start' to launch the service.

```shell
orchestrator setup 
orchestrator start
```

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

### Setup Orchestrator (Shell)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=installation-upgrading-orchestrator-235-401-in-high-availability

Initiates the setup process for Orchestrator after installation. This command is essential for configuring the newly installed version.

```shell
# asctl orchestrator:setup
```

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

### Create Setup File

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orchestrator-create-setup-file

This asctl method creates a reusable file that contains responses to the setup prompts during the Orchestrator installation process. It simplifies and standardizes installation procedures.

```APIDOC
## Create Setup File

### Description
This asctl method creates a reusable file that contains responses to the setup prompts during the Orchestrator installation process. It simplifies and standardizes installation procedures.

### Method
`asctl orchestrator:create_setup_file`

### Endpoint
N/A (CLI Command)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
asctl orchestrator:create_setup_file /path/to/your/setup_file.json
```

### Response
#### Success Response
STDOUT indicating the progress of the setup file creation and a success message.

#### Response Example
```
Setup file created successfully at /path/to/your/setup_file.json
```

#### Error Response
STDOUT indicating a failure message if the setup file creation fails.
```

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

### Initiate MySQL Setup (asctl)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=installation-installing-orchestrator-mysql-remote-server

Starts the MySQL configuration process using the 'asctl' command-line tool. This command is used to set up the MySQL database for Orchestrator. It prompts for setup mode (streamlined or detailed).

```bash
# asctl mysql:setup
```

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

### Install IBM Aspera Orchestrator (RPM)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=installation-installing-orchestrator-mysql-same-server

Installs the IBM Aspera Orchestrator package using the yum package manager. This command is run as root after installing the common components. It prepares the system for Orchestrator setup, which is completed by running 'asctl orchestrator:setup'.

```bash
# yum install aspera-orchestrator-version-0x86_64.rpm 
Preparing...########################################### [100%]
. . .
To complete the setup of Orchestrator, run "asctl orchestrator:setup"
```

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

### Create Orchestrator Setup File using asctl

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orchestrator-create-setup-file

This asctl method generates a setup file for Orchestrator installations, pre-populating responses to setup prompts. It requires a file path as input and outputs progress and status messages to STDOUT. This method is useful for automating or standardizing Orchestrator deployments.

```bash
asctl orchestrator:create_setup_file file_path
```

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

### Response Example: Engine Start (XML)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=management-control-process

This is an example XML response from the Orchestrator API after initiating an 'start' command for the engine process. It provides status details for various running processes.

```xml
<processes time="2015-12-03 10:29:19 UTC" action="status" engine_id="0">
<process class="engine" pid="83296" status="running"/>
<process class="mongrel" pid="83301" status="running" port="3000"/>
<process class="mongrel" pid="83303" status="running" port="3001"/>
<process class="mongrel" pid="83305" status="running" port="3002"/>
<process class="monitor" pid="83299" status="running"/>
<process class="worker" id="0" pid="83312" status="running" type="asynchronous"/>
<process class="worker" id="1" pid="83314" status="running" type="asynchronous"/>
<process class="worker" id="2" pid="83316" status="running" type="normal"/>
<process class="worker" id="3" pid="83318" status="running" type="normal"/>
<process class="worker" id="4" pid="83320" status="running" type="normal"/>
<process class="worker" id="5" pid="83310" status="running" type="normal"/>
</processes>
```

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

### Troubleshoot Orchestrator Setup - MySQL Data Directory (Shell)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=installation-upgrading-orchestrator-235-401-in-high-availability

Provides commands to resolve issues during Orchestrator setup when the process stops at 'Starting MySQL'. It involves unlinking and recreating the MySQL data directory symbolic link.

```shell
# cd /opt/aspera/common/mysql
# unlink data
# mv data,bak data
# asctl orchestrator:setup
# mv data data.bak
# ln -s /mnt/shared/orchestrator/mysql_data/ ./data
```

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

### Run Orchestrator Setup

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=installation-upgrading-orchestrator-400-410-in-high-availability

Executes the Orchestrator setup script to initialize or configure the Orchestrator service after installation or upgrade. This command is typically run as root.

```bash
# orchestrator setup
```

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

### Troubleshooting MySQL Startup in Aspera Orchestrator

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=troubleshooting-high-availability-setups

This section addresses common issues when MySQL fails to start within IBM Aspera Orchestrator's high availability setup. It covers solutions for syntax errors in the database configuration file, permission problems on the MySQL data directory, and verification of user account details.

```bash
MySQL: Start...not starting 
'Error executing '/opt/aspera/common/mysql/share/mysql/mysql.server' start' ().
Starting MySQL...................................................................
```

```yaml
production: 
  host: 127.0.0.1 
  primary_host: 10.68.62.132 
  alternate_host: 10.68.62.133 
  port: 4406 
  adapter: mysql2 
  username: root 
  password: aspera 
  database: orchestrator 
  checkout_timeout: 1 
  pool: 10
```

```bash
# ll /opt/aspera/common/mysql/data/ -d 
drwxr-x--- 7 mysql mysql 4096 Mar 10 16:37 /opt/aspera/common/mysql/data/
```

```bash
# id mysql 
uid=998(mysql) gid=997(mysql) groups=997(mysql)
```

```bash
# sudo -u mysql touch /opt/aspera/common/mysql/data/file.txt
```

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

### Set Up MySQL Database

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=installation-install-orchestrator

Configures a MySQL database for Orchestrator. This includes starting the MySQL service, setting the root password, creating a user with remote access, granting necessary privileges, and enabling the service to start on boot.

```shell
systemctl start mysqld
mysql -uroot -hlocalhost -p
ALTER USER 'root'@'localhost' IDENTIFIED BY '<YOUR_PASSWORD>';
CREATE USER IF NOT EXISTS 'root'@'%' IDENTIFIED BY '<YOUR_PASSWORD>';
GRANT ALL ON *.* TO 'root'@'localhost';
GRANT ALL ON *.* TO 'root'@'%';
flush privileges;
exit
systemctl enable mysqld
```

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

### Mounting Shared Storage

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=installation-storage-requirements

This command demonstrates how to mount shared external storage, essential for high availability setups. It specifies the network file system version, protocol, and port, and requires the shared storage location and a mount point on the local system. The example shows a typical NFS mount.

```bash
$ mount -v -o vers=3,proto=tcp,port=2049 shared_storage mount_point
```

```bash
$ mount -v -o vers=3,proto=tcp,port=2049 ha_storage.aspera.us /mnt
```

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

### Install Aspera Common Components (RPM)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=installation-installing-orchestrator-mysql-same-server

Installs the Aspera Common Components using the yum package manager. This is a prerequisite for installing Orchestrator. The command assumes you are running it as root and have the RPM file in the current directory.

```bash
# yum install aspera-common-version-0.x86_64.rpm
Preparing...                          ################################# [100%]
Updating / installing...
   1:aspera-common-version-0    ################################# [100%]
```

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

### Start Orchestrator Mongrels using ASCTL

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orchestrator-start-mongrels

This command starts the processes responsible for rendering the IBM Aspera Orchestrator user interface. It requires no input and outputs messages to STDOUT indicating the successful start of the Orchestrator Mongrel processes.

```shell
asctl orchestrator:start_mongrels
```

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

### Copy Sample Nginx Configuration

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=installation-zero-downtime-patching-in-high-availability-cluster

Copies the sample Nginx configuration file for high availability to the system's Nginx directory. This serves as a template for setting up the load balancer.

```bash
sudo cp /opt/aspera/orchestrator/config/ha_nginx.conf.sample /etc/nginx/ha_nginx.conf
```

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

### Get All Plugin Versions - Orchestrator API

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=portlets-plugin-version

This endpoint retrieves the version information for all installed plugins in the IBM Aspera Orchestrator. It requires the Orchestrator IP address and returns an XML response listing each plugin's name and version. No specific authentication details are shown in this example, but 'login=admin' is present.

```HTTP
https://Orchestrator_IP_address/aspera/orchestrator/api/plugin_version?login=admin
```

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

### Initiate Work Order Example Request URL

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orders-initiate-work-order

A concrete example of the initiate work order request URL, demonstrating the inclusion of a specific workflow ID.

```http
http://Orchestrator_IP_address/aspera/orchestrator/api/initiate/xml?login=admin&work_order[workflow_id]=1
```

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

### Get All Plugin Versions

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=portlets-plugin-version

Retrieves the versions of all installed plugins in the Aspera Orchestrator.

```APIDOC
## GET /aspera/orchestrator/api/plugin_version

### Description
Retrieves a list of all installed plugins and their respective versions.

### Method
GET

### Endpoint
`https://Orchestrator_IP_address/aspera/orchestrator/api/plugin_version?login=admin`

### Query Parameters
- **login** (string) - Required - The login credentials for the Orchestrator.

### Response
#### Success Response (200)
- **PluginVersion** (XML) - Contains a list of Plugin elements, each with a name and version.
  - **Plugin** (XML)
    - **version** (string) - The version of the plugin.
    - **name** (string) - The name of the plugin.

### Response Example
```xml
<PluginVersion>
<Plugin>
<version>1.1.6</version>
<name>AscpClient</name>
</Plugin>
<Plugin>
<version>2.6.0</version>
<name>AsperaCentralWatcher</name>
</Plugin>
</PluginVersion>
```
```

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

### Troubleshoot MySQL Startup Errors in IBM Aspera Orchestrator

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=troubleshooting-high-availability-setups

This snippet addresses common 'MySQL: Start...not starting' errors in IBM Aspera Orchestrator. It covers checking the database.yml configuration for syntax errors, verifying file permissions for the MySQL data directory, ensuring consistent user/group IDs for the mysql user across cluster nodes, and testing write permissions within the data directory.

```yaml
production:
  host: 127.0.0.1
  primary_host: 10.68.62.132
  alternate_host: 10.68.62.133
  port: 4406
  adapter: mysql2
  username: root
  password: aspera
  database: orchestrator
  checkout_timeout: 1
  pool: 10
```

```bash
# ll /opt/aspera/common/mysql/data/ -d
drwxr-x--- 7 mysql mysql 4096 Mar 10 16:37 /opt/aspera/common/mysql/data/
```

```bash
# id mysql
uid=998(mysql) gid=997(mysql) groups=997(mysql)
```

```bash
# sudo -u mysql touch /opt/aspera/common/mysql/data/file.txt
```

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

### Example Response: All Outputs for a Work Order

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orders-get-output-work-order

This XML response shows all the output variables for a given work order. It includes multiple 'variable' elements, each detailing a specific output from potentially different steps within the work order.

```XML
<?xml version="1.0"?>
<work_order_output time="2014-03-24 21:25:47 UTC" action="output">
   <variable id="29629" name="Successful ingest notification:FullMessage">
      <workorder_id>11109</workorder_id>
      <step_name>Successful ingest notification</step_name>
      <variable_name>FullMessage</variable_name>
      <value_type>string</value_type>
      <value><MessageDefinition><Destinations><To>pavan+support@asperasoft.com</To></Destinations><Subject>Ingest successful of wall_e_12.avi for Turner</Subject></MessageDefinition>
</value>
      <variable_type>OUTPUT</variable_type>
   </variable>
   <variable id="29630" name="Ingest failure:FullMessage">
      <workorder_id>11109</workorder_id>
      <step_name>Ingest failure</step_name>
      <variable_name>FullMessage</variable_name>
      <value_type>string</value_type>
      <value></value>
      <variable_type>OUTPUT</variable_type>
   </variable>
   <variable id="29631" name="Update failure:manifest">
      <workorder_id>11109</workorder_id>
      <step_name>Update failure</step_name>
      <variable_name>manifest</variable_name>
      <value_type>string</value_type>
      <value></value>
      <variable_type>OUTPUT</variable_type>
   </variable>
   <variable id="29632" name="Update failure:manifest_id">
      <workorder_id>11109</workorder_id>
      <step_name>Update failure</step_name>
      <variable_name>manifest_id</variable_name>
      <value_type>int</value_type>
      <value></value>
      <variable_type>OUTPUT</variable_type>
   </variable>
   <variable id="29637" name="Scan for incoming files:FileName">
      <workorder_id>11109</workorder_id>
      <step_name>Scan for incoming files</step_name>
      <variable_name>FileName</variable_name>
      <value_type>string</value_type>
      <value>/demo/comcast/to_turner/wall_e_12.avi</value>
      <variable_type>OUTPUT</variable_type>
   </variable>
</work_order_output>
```

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

### Example HTTP Request for Workflow Outputs Spec

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=endpointsworkflows-get-output-specification-workflow

This example demonstrates a concrete HTTP GET request to the Aspera Orchestrator API, substituting 'workflow_id' with a specific ID ('878'). This is useful for testing or direct API interaction.

```http
http://Orchestrator_IP_address/aspera/orchestrator/api/workflow_outputs_spec?login=admin&workflow_id=878
```

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

### Create Orchestrator Mount Points

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=ioihae-setting-up-mount-points-shared-orchestrator-var-data

These commands create the necessary directory structure on the shared mount point for Orchestrator's /var data. This includes directories for archives, configurations, and runtime data.

```bash
cd /mnt/shared/orchestrator/orchestrator_var_data
mkdir -p var/archive/orchestrator
mkdir -p var/config/orchestrator
mkdir -p var/run/orchestrator
```

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

### Get Installed Orchestrator Version (Bash)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=installation-uninstalling-orchestrator

This command retrieves the installed version number of IBM Aspera Orchestrator by querying the rpm package manager. It helps identify the correct version for uninstallation.

```bash
# rpm -qa grep aspera
```

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

### Edit Pool Capacity Request Example

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=endpointsresources-edit-pool-capacity

This is an example of an HTTP GET request to the Aspera Orchestrator API to edit the capacity of a specific pool. It includes the server address, API endpoint, pool ID, pool name, and desired format.

```http
https://10.0.71.152/aspera/orchestrator/api/edit_pool_capacity/4?pool_name=gen_pool_test&format=json
```

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

### XML Response Example - All Plugin Versions

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=portlets-plugin-version

An example of the XML response format when querying for all plugin versions from the IBM Aspera Orchestrator API. It lists multiple plugins, each within a `<Plugin>` tag, showing their `<name>` and `<version>`.

```XML
<PluginVersion>
<Plugin>
<version>1.1.6</version>
<name>AscpClient</name>
</Plugin>
<Plugin>
<version>2.6.0</version>
<name>AsperaCentralWatcher</name>
</Plugin>
<Plugin>
<version>0.0.3</version>
<name>AsperaNodeApi</name>
</Plugin>
<Plugin>
<version>0.0.6</version>
<name>AsperaNodeFileWatcher</name>
</Plugin>
<Plugin>
<version>0.1.0</version>
<name>AsperaNodeSearch</name>
</Plugin>
<Plugin>
<version>0.4.1</version>
<name>ConsoleNotification</name>
</Plugin>
<Plugin>
<version>0.2.4</version>
<name>CustomRuby</name>
</Plugin>
<Plugin>
<version>0.3.0</version>
<name>FaspControl</name>
</Plugin>
<Plugin>
<version>2.5.5</version>
<name>FaspTransfer</name>
</Plugin>
<Plugin>
<version>0.5.1</version>
<name>FaspexDelivery</name>
</Plugin>
<Plugin>
<version>1.2.3</version>
<name>FaspexInboxWatcher</name>
</Plugin>
<Plugin>
<version>0.2.7</version>
<name>Filter</name>
</Plugin>
</PluginVersion>
```

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

### Initiate Work Order XML Response Example

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orders-initiate-work-order

An example of the XML response received after successfully initiating a work order. It includes details such as the work order ID, name, workflow information, status, and initiation details.

```xml
<?xml version="1.0"?>
<work_order time="2014-11-25 13:24:01 UTC" action="initiate" id="8464" workflow_id="1">
   <workorder_id>8464</workorder_id>
   <name>create file</name>
   <workflow id="1" revision_id="14">create file</workflow>
   <status state="Created">WorkOrder created at Tue Nov 25 07:24:01 CST 2014</status>
   <comments/>
   <parameters></parameters>
   <ownership>
      <initiated_by>admin</initiated_by>
      <running_as>system</running_as>
      <launched_by>admin</launched_by>
   </ownership>
   <priority dedicated_worker="false"/>
   <work_steps></work_steps>
</work_order>
```

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

### GET /aspera/orchestrator/api/plugin_version

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=portlets-plugin-version

Retrieves the versions of all installed plugins on the Aspera Orchestrator. This endpoint requires the Orchestrator IP address and a login parameter.

```APIDOC
## GET /aspera/orchestrator/api/plugin_version

### Description
Retrieves the versions of all installed plugins on the Aspera Orchestrator.

### Method
GET

### Endpoint
`https://Orchestrator_IP_address/aspera/orchestrator/api/plugin_version`

### Parameters
#### Query Parameters
- **login** (string) - Required - The login username for authentication.

### Request Example
```
https://Orchestrator_IP_address/aspera/orchestrator/api/plugin_version?login=admin
```

### Response
#### Success Response (200)
- **PluginVersion** (xml) - Contains a list of Plugin elements, each with a name and version.

#### Response Example
```xml
<PluginVersion>
<Plugin>
<version>1.1.6</version>
<name>AscpClient</name>
</Plugin>
<Plugin>
<version>2.6.0</version>
<name>AsperaCentralWatcher</name>
</Plugin>
</PluginVersion>
```
```

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

### Response Example: All Portlet Versions (XML)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=portlets-portlet-version

This is an example of the XML response received when querying the API for all portlet versions. It contains a list of `<Portlet>` elements, each with a `<version>` and `<name>` tag, detailing the version and name of each portlet.

```XML
<PortletVersion>
<Portlet>
<version>0.0.1</version>
<name>Return records</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Connect Upload</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>CSV Editor</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>File Browser</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Filter Work Orders</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Journal View</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Managed Load Utilization Monitor</name>
</Portlet>
<Portlet>
<version>0.0.4</version>
<name>Monitors Dashboard</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Orchestrator Information</name>
</Portlet>
<Portlet>
<version>0.0.3</version>
<name>Orchestrator Processes</name>
</Portlet>
<Portlet>
<version>0.0.5</version>
<name>Queue Manager</name>
</Portlet>
<Portlet>
<version>0.0.5</version>
<name>Managed Resource Utilization Monitor</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Workflow Step Activity</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Step Performance Statistics</name>
</Portlet>
<version>0.0.8</version>
<name>Workflow Step Statistics</name>
</Portlet>
<Portlet>
<version>0.0.3</version>
<name>User pending tasks</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Virtual Catcher Portlet</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Virtual Catcher Status</name>
</Portlet>
<Portlet>
<version>0.0.4</version>
<name>Workflow Statistics</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Workflow Performance Statistics</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Group assigned tasks</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Custom Portlet</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Dalet Import</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>WWE Delivery Status</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>France TV Journals</name>
</Portlet>
</PortletVersion>
```

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

### Edit Resource Capacity API Request Example

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=endpointsresources-edit-resource-capacity

This example shows a GET request to the IBM Aspera Orchestrator API to edit the capacity of a specific resource. It includes parameters for resource name, pool name, and desired format. The API endpoint is designed for modifying resource configurations.

```http
https://10.0.71.152/aspera/orchestrator/api/edit_resource_capacity/4?resource_name=127.0.0.7&pool_name=load_test&format=json
```

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

### Offline Resource API Request Example (HTTP)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=endpointsresources-take-resource-offline

This example demonstrates an HTTP GET request to take a resource offline via the Aspera Orchestrator API. It specifies the resource name, pool name, and desired output format. The API endpoint is for internal IBM network access.

```HTTP
GET https://10.0.71.152/aspera/orchestrator/api/resource_offline?resource_name=127.0.0.1&pool_name=load_test&format=json
```

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

### Queue Item API Request Example

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=endpointsqueues-queue-item

This example demonstrates how to make an HTTP GET request to the Aspera Orchestrator API to add a queue item. It includes parameters for login, API key, item details, description, weight, and priority. The API endpoint is specified by the Orchestrator IP address.

```http
http://Orchestrator_IP_address/aspera/orchestrator/api/queue_item?login=admin2&api_key=d5e6b80f061533ec8d70470b12ee861e7e474bb8&id=queue_5&queued_item=Item 35&description=Item 35 desc&weight=15&priority=35
```

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

### Get Portlet Version

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=portlets-portlet-version

This endpoint retrieves the installed version of a single portlet or all portlets. The response is XML by default, but can be changed to JSON by appending '&format=json' to the request.

```APIDOC
## GET /portlet/version

### Description
Retrieves the installed version of a single portlet or all portlets.

### Method
GET

### Endpoint
/portlet/version

### Query Parameters
- **format** (string) - Optional - Specifies the response format. Use 'json' for JSON output.

### Request Example
```
GET /portlet/version?format=json
```

### Response
#### Success Response (200)
- **version** (string) - The installed version of the portlet.

#### Response Example
```json
{
  "version": "1.2.3"
}
```
```

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

### Example HTTP Request and XML Response for Workflow Outputs

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=endpointsworkflows-get-output-specification-workflow

Provides a concrete example of an HTTP request with a sample 'workflow_id' and the corresponding XML response structure. The response details various contexts within the workflow, including step names, variable names, and creation timestamps.

```http
http://Orchestrator_IP_address/aspera/orchestrator/api/workflow_outputs_spec?login=admin&workflow_id=878
```

```xml
<?xml version="1.0"?>
<workflow_outputs_spec time="2012-09-14 23:04:50 UTC" action="opspec">
      <context id="5513">
        <workflow_id>878</workflow_id>        
        <step_name>Parameter</step_name>
        <variable_name>input</variable_name>
        <value_type>string</value_type>
        <variable_type></variable_type>
        <created_at>2012-09-11 00:31:22 UTC</created_at>
        <updated_at>2012-09-11 00:31:22 UTC</updated_at>
      </context>
      <context id="5512">
        <workflow_id>878</workflow_id>
<step_name>Test FedWF</step_name>
        <variable_name>message</variable_name>
        <value_type>string</value_type>
        <variable_type></variable_type>
        <created_at>2012-09-11 00:31:22 UTC</created_at>
        <updated_at>2012-09-11 00:31:22 UTC</updated_at>
      </context>
</work_order_outputs_spec>
```

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

### Start Orchestrator Rails Console (Linux)

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=environments-high-availability-installation

This command initiates the Rails console for IBM Aspera Orchestrator, providing an interactive environment to manage configurations. It's essential for advanced settings and troubleshooting.

```bash
rails c
```

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

### Start Orchestrator Service on Linux

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.0_topic=orchestrator-starting

Commands to start the IBM Aspera Orchestrator service on a Linux machine. Requires root privileges to execute.

```bash
# asctl orchestrator:start

```

```bash
# /etc/init.d/AsperaOrchestrator start

```

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

### Aspera Orchestrator API Request for Resource Offline

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=endpointsresources-take-resource-offline

This is an example of an HTTP GET request to the Aspera Orchestrator API to take a specific resource offline. It includes parameters for resource name, pool name, and desired output format. The API endpoint is for managing resources within the Orchestrator.

```http
https://10.0.71.152/aspera/orchestrator/api/resource_offline?resource_name=127.0.0.1&pool_name=load_test&format=json
```

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

### Response Example: All Portlets

Source: https://www.ibm.com/docs/en/aspera-orchestrator/4.1_topic=portlets-portlet-version

This is an example of the XML response when requesting the version information for all portlets. It lists each portlet with its corresponding version number. This format is useful for programmatic parsing and integration.

```XML
<PortletVersion>
<Portlet>
<version>0.0.1</version>
<name>Return records</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Connect Upload</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>CSV Editor</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>File Browser</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Filter Work Orders</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Journal View</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Managed Load Utilization Monitor</name>
</Portlet>
<Portlet>
<version>0.0.4</version>
<name>Monitors Dashboard</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Orchestrator Information</name>
</Portlet>
<Portlet>
<version>0.0.3</version>
<name>Orchestrator Processes</name>
</Portlet>
<Portlet>
<version>0.0.5</version>
<name>Queue Manager</name>
</Portlet>
<Portlet>
<version>0.0.5</version>
<name>Managed Resource Utilization Monitor</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Workflow Step Activity</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Step Performance Statistics</name>
</Portlet>
<version>0.0.8</version>
<name>Workflow Step Statistics</name>
</Portlet>
<Portlet>
<version>0.0.3</version>
<name>User pending tasks</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Virtual Catcher Portlet</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Virtual Catcher Status</name>
</Portlet>
<Portlet>
<version>0.0.4</version>
<name>Workflow Statistics</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Workflow Performance Statistics</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Group assigned tasks</name>
</Portlet>
<Portlet>
<version>0.0.2</version>
<name>Custom Portlet</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>Dalet Import</name>
</Portlet>
<Portlet>
<version>0.0.1</name>
<name>WWE Delivery Status</name>
</Portlet>
<Portlet>
<version>0.0.1</version>
<name>France TV Journals</name>
</Portlet>
</PortletVersion>
```
Tokens:
Raw