Skip to main content

Orchestrate Next Gen

Create Cyware Agent

You can create Cyware agents to create a secure and dedicated gateway to enable seamless automation interoperability between on-premise solutions deployed in a customer infrastructure and the Orchestrate application deployed in the public cloud. 

Before you Start 

  • Ensure that you have Create, View, and Update Cyware Agent Configuration permissions.

  • Ensure that you have Create, View, and Update Open APIs permissions. 

  • Ensure that you meet the prerequisites to create a Cyware agent. For more information about prerequisites, see Prerequisites.

  • Ensure that you meet the system requirements to create a Cyware agent. For more information about system requirements, see System Requirements. 

Steps 

To create a Cyware agent, follow these steps:

  1. Go to Admin Panel > Cyware Agent. 

  2. Click New Agent Group.

  3. Enter a name for the agent. By default, the agent name is Agent_timestamp. For example, Support_Agent. 

  4. Select an API key to establish a connection with Orchestrate. Click on the New API key to create new API credentials. For more information, see Create OpenAPI

  5. Click View Additional Settings to configure additional settings and enter the following details:

    • Polling Frequency: Enter polling frequency between 1 and 60 minutes in which an agent can poll tasks. By default, it is 1. 

      Note

      • Polling is the process of retrieving information from a primary application using the Cyware Agent.

      • Tasks indicate the maximum number of tasks that the Orchestrate can request the Agent to execute in one poll.

      • Administrators receive timely updates of Cyware Agent polling errors via email notifications. This helps administrators to stay up-to-date on Cyware Agent failures and troubleshoot instantly.

    • Max Allowed Tasks: Enter the number of tasks to be polled in the range of 1 to 100. By default, the maximum allowed number of tasks is 10.  

    • Mount Directory: Enter the directory to mount the Cyware Agent. For example: /apps/cyware/cyware_agent.

    • (Optional) Proxy: Enter any of the proxy HTTP, HTTPS, and No Proxy methods to forward the network requests to a proxy server. This helps in enhancing the security of on-premises resources. You can enter multiple proxies by using commas as a delimiter. 

    • (Optional) Extra Mount: Enter the values for the extra mount in key-value pairs. You can specify an extra mount to let the agent access another directory. 

  6. Click Create Agent.

You will get a command to install Cyware Agent. For more information about installing Cyware Agent, see Install Cyware Agent.

Create Open API Credential

You can create Open API credentials while creating a Cyware Agent. 

Before you Start 

Ensure that you have  Create, View, and Update Open APIs permissions. 

Steps 

To create Open API credentials in Cyware Agent creation, follow these steps:

  1. Click New API Key and enter the following details:

    • Title: Enter a title for the API credentials. By default, it is Agent_API_Timestamp.

    • Workspace: Select a workspace. The created Open API can be used to integrate an external application with the selected workspace. For more information on workspaces, see Workspaces.

    • User: Select the user who can use these open API credentials. 

    • Expiry Settings: Select Expires On and enter the time that the credentials will expire, or select Never Expires. 

  2. Click Create and Use to use the new credentials for the creation of Cyware Agent.