CLI: Profiles



On This Page

 


The CLI references “skysync.” This is expected.

Profiles

List Profiles

parameter

description

required

default

parameter

description

required

default

search, q

Search text

optional

 

offset

Search offset

optional

0

limit

Search page size

optional

20

Example 1: List all the profiles

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

skysync-cli profiles list

Example results

ID Name 40387f13ad504f998074a8b47a48168c Profile 1 9d06d20692f0469ba74b556827a9df2c Profile 2

Example results (JSON)

[ { "id": "40387f13ad504f998074a8b47a48168c", "name": "Profile 1" }, { "id": "9d06d20692f0469ba74b556827a9df2c", "name": "Profile 2" } ]

 

Example 2: List profiles with "Profile 1" in their name

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

Command

 

Example 3: List the profiles skipping the first 2 and showing 3 results

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

 

Show a Profile

This command will show the details of the specified profile.

parameter

description

required

default

parameter

description

required

default

id

The ID of the profile for which details will be shown

required

 

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

Command with example values

Example results

Example results (JSON)


If the ID entered does not correspond to an existing profile, for example, if the profile was already deleted, the expected output is the following.

Expected results

Expected results (JSON)

 

Download a Profile Installation Package

This command downloads an Installation Package for a Profile.  By default, the installation package is an appSettings.json file, but it can also include the installer if configured on the server

parameter

description

required

default

parameter

description

required

default

id

The ID of the profile for which the installation package will be downloaded

required

 

targetDirectory

Relative or absolute path to save the downloaded installation package

optional

(current directory)

In the following examples, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) need to be replaced with valid values.

Example 1: Download profile package to default directory

Command with variables

Command with example values

Example results

 

Example 2: Download profile package to specified directory

Command with variables

Command with example values

Example results

 

Create a Profile

This command will create a profile.

parameter

description

required

default

parameter

description

required

default

name

The name of the profile

required

 

description

Profile description

optional

 

instructions

Profile instructions

optional

 

templates

A comma separated list of the job templates to associate to this new profile.  Both the ID and kind of the job template must be specified (ie. 123456:transfer)

optional

 

Example 1: Creating a simple profile

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

Command with example values

Example results

Example results (JSON)

 

Example 1: Creating a profile

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

Command with example values

Example results

Example results (JSON)

 

Delete a Profile

This command will delete the specified profile

parameter

description

required

default

parameter

description

required

default

id

The ID of the profile to be deleted

required

 

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  The parameters within the two curly braces (including the braces) will need to be replaced with valid values.

Command with variables

Command with example values

Expected results

If the ID entered does not correspond to an existing profile, for example, if the profile was already deleted, the expected output is the following.

Expected results























DryvIQ Migrate Version: 5.6.1.4136
Release Date: February 9, 2024