Configuring

The orka config command in the Orka CLI. This command is used for basic service configuration.

Command

This command lets you set the API URLAPI URL - The Orka API service runs at a specific URL and port. Orka CLI commands and Orka API calls are executed against the Orka API URL. The MacStadium team will provide the API URL., the license key, and the output style.

orka config

OR

orka config -a <ORKA_API_URL> -l <ORKA_LICENSE_KEY> --output-style <OUTPUT-STYLE> -y

Output

  • (Required) For URL, provide the service endpoint for your Orka environment in the following format: http://<orka-service-endpoint-ip> or https://<orka-custom-domain>.

📘

What's your Orka endpoint?

You can get the IP for your Orka endpoint from your IP Plan. It's the .100 address for your Private-1 network. Usually, 10.221.188.100 or 10.10.10.100. You need to use http with the IP.

To get the custom domain for your Orka cluster, if enabled:

  1. Log into your MacStadium account.
  2. Go to Subscriptions (from the top right corner) and select your Orka cluster.
  3. In the Subscription & Plan details, find your custom domain at the bottom. If you don't see a custom domain field, it's not enabled for your environment yet.
    You need to use https with your custom domain.

Note that you can use both http://<orka-IP> and https://<orka-custom-domain> in your workflows.

📘

Using a custom domain?

If you're using OpenConnect to access your Orka cluster via VPN, you need to add a DNS server to your network configuration.

If you're using Cisco AnyConnect on macOS or Linux, you're already set and you don't need to make any changes. If you're using Cisco AnyConnect on Windows, you need to add a DNS server.

  • (Optional) For License key, provide your Orka license key as provided in your IP Plan or by administrator.
  • (Optional) For Output style, set TABLE or JSON. If you set JSON, Orka will provide the output in JSON .

Options

You can pass the following options in direct mode:

Option

Description

Sample value

-a

The API URLAPI URL - The Orka API service runs at a specific URL and port. Orka CLI commands and Orka API calls are executed against the Orka API URL. The MacStadium team will provide the API URL. for your Orka environment.

The default Orka service endpoint is http://10.221.188.100 OR http://10.10.10.100. Check your IP Plan for your actual endpoint.

If you have a custom domain enabled, you can use https://<orka-custom-domain> instead.

http://10.221.188.100

OR

http://10.10.10.100

OR

https://company.orka.app

-l

The value for your Orka license key. When specified, this option also stores the license key locally for use by other commands.

orka-license-key

--output-style

The value of the output style. Defaults to TABLE. Specifying JSON disables interactive mode causes all output to be JSON.

TABLE

OR

JSON

-y

Bypasses the interactive prompt and executes the command with the specified parameters.

--json

Returns the output of the command in JSON.


Did this page help you?