<a id="instance-profile"></a>

# instance-profile

## instance-profile add-role

**Usage**

```none
  usage: symp instance-profile add-role
[-f {adaptive_table,json,shell,table,value,yaml}]
                                        [-c COLUMN] [--max-width <integer>]
                                        [--fit-width] [--print-empty]
                                        [--noindent] [--prefix PREFIX]
                                        [-m [NAME=VALUE [NAME=VALUE ...]]]
                                        instance_profile_id role_id
```

**Description**

Adds the specified role to the specified instance profile.
An instance profile can contain only one role, and this limit cannot be increased.
You can remove the existing role and then add a different role to an instance profile.

**Mandatory**

```none
positional arguments:
  instance_profile_id   The ID of the instance profile to update
  role_id               The ID of the role to add
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## instance-profile create

**Usage**

```none
  usage: symp instance-profile create
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty] [--noindent]
                                      [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      [--path PATH] [--project-id PROJECT_ID]
                                      name
```

**Description**

Creates a new instance profile.

**Returns**

Returns dict: A structure containing details about the new instance profile

**Mandatory**

```none
positional arguments:
  name                  The name of the instance profile to create
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --path PATH           The path to the instance profile
  --project-id PROJECT_ID
                        The ID of the project in which the instance-profile will be created (for admin only)
```

## instance-profile get

**Usage**

```none
  usage: symp instance-profile get
[-f {adaptive_table,json,shell,table,value,yaml}]
                                   [-c COLUMN] [--max-width <integer>]
                                   [--fit-width] [--print-empty] [--noindent]
                                   [--prefix PREFIX]
                                   [-m [NAME=VALUE [NAME=VALUE ...]]]
                                   instance_profile_id
```

**Description**

Retrieves information about the specified instance profile.

**Returns**

Returns dict: A structure containing details about the instance profile

**Mandatory**

```none
positional arguments:
  instance_profile_id   The ID of the instance-profile to get
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## instance-profile list

**Usage**

```none
  usage: symp instance-profile list
[-f {adaptive_table,csv,json,table,value,yaml}]
                                    [-c COLUMN] [--max-width <integer>]
                                    [--fit-width] [--print-empty] [--noindent]
                                    [--quote {all,minimal,none,nonnumeric}]
                                    [-m [NAME=VALUE [NAME=VALUE ...]]]
                                    [--sort-column SORT_COLUMN] [--name NAME]
                                    [--project-id PROJECT_ID]
```

**Description**

Lists the instance profiles.

**Returns**

Returns list: The instance profiles

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
  --name NAME           Only list instance profiles with the given name
  --project-id PROJECT_ID
                        ID of project to list instance profiles for (only for admin)
```

## instance-profile remove

**Usage**

```none
  usage: symp instance-profile remove
[-f {adaptive_table,json,shell,table,value,yaml}]
                                      [-c COLUMN] [--max-width <integer>]
                                      [--fit-width] [--print-empty] [--noindent]
                                      [--prefix PREFIX]
                                      [-m [NAME=VALUE [NAME=VALUE ...]]]
                                      instance_profile_id
```

**Description**

Deletes the specified instance profile. The instance profile must not have an associated role.

**Mandatory**

```none
positional arguments:
  instance_profile_id   The ID of the instance-profile to remove
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```

## instance-profile remove-role

**Usage**

```none
  usage: symp instance-profile remove-role
[-f {adaptive_table,json,shell,table,value,yaml}]
                                           [-c COLUMN] [--max-width <integer>]
                                           [--fit-width] [--print-empty]
                                           [--noindent] [--prefix PREFIX]
                                           [-m [NAME=VALUE [NAME=VALUE ...]]]
                                           instance_profile_id role_id
```

**Description**

Removes the specified role from the specified instance profile.

**Mandatory**

```none
positional arguments:
  instance_profile_id   The ID of the instance profile to update
  role_id               The ID of the role to remove
```

**Optional**

```none
optional arguments:
  -h, --help            show this help message and exit
```
