Drive Security Policy
IntersightA Drive Security Policy configures self-encrypting drive (SED) security for UCS servers. It controls how encryption keys are managed — either through a locally stored manual passphrase or a remote KMIP key management server. The policy is applied to servers via a Server Profile Template.
Location in Intersight GUI:
Policies » Drive Security
Diagram
Section titled “Diagram”Classes
Section titled “Classes”compute
Section titled “compute”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| intersight | Class | intersight | No |
intersight (compute)
Section titled “intersight (compute)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| organizations | List | organizations | No |
organizations (compute.intersight)
Section titled “organizations (compute.intersight)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| policies | Class | policies | No |
policies (compute.intersight.organizations)
Section titled “policies (compute.intersight.organizations)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| drive_security | List | drive_security | No |
drive_security (compute.intersight.organizations.policies)
Section titled “drive_security (compute.intersight.organizations.policies)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| name | String | Regex: ^[a-zA-Z0-9_ | Yes | |
| description | String | No | ||
| managed | Boolean | true, false | No | true |
| tags | List | tags | No | |
| key_setting | Class | key_setting | No |
tags (compute.intersight.organizations.policies.drive_security)
Section titled “tags (compute.intersight.organizations.policies.drive_security)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| key | String | Yes | ||
| value | String | No | ||
| type | Choice | KeyValue, PathTag | No |
key_setting (compute.intersight.organizations.policies.drive_security)
Section titled “key_setting (compute.intersight.organizations.policies.drive_security)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| key_type | Choice | Manual, Kmip | No | |
| manual_key | Class | manual_key | No | |
| remote_key | Class | remote_key | No |
manual_key (compute.intersight.organizations.policies.drive_security.key_setting)
Section titled “manual_key (compute.intersight.organizations.policies.drive_security.key_setting)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| existing_key | String | No | ||
| new_key | String | No |
remote_key (compute.intersight.organizations.policies.drive_security.key_setting)
Section titled “remote_key (compute.intersight.organizations.policies.drive_security.key_setting)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| existing_key | String | No | ||
| server_ | String | No | ||
| auth_ | Class | auth_ | No | |
| primary_server | Class | primary_server | No | |
| secondary_ | Class | secondary_ | No |
auth_credentials (compute.intersight.organizations.policies.drive_security.key_setting.remote_key)
Section titled “auth_credentials (compute.intersight.organizations.policies.drive_security.key_setting.remote_key)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| use_ | Boolean | true, false | No | |
| username | String | No | ||
| password | String | No |
primary_server (compute.intersight.organizations.policies.drive_security.key_setting.remote_key)
Section titled “primary_server (compute.intersight.organizations.policies.drive_security.key_setting.remote_key)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ip_address | String | No | ||
| port | Integer | min: 1, max: 65535 | No | |
| timeout | Integer | min: 1 | No | |
| enable_ | Boolean | true, false | No |
secondary_server (compute.intersight.organizations.policies.drive_security.key_setting.remote_key)
Section titled “secondary_server (compute.intersight.organizations.policies.drive_security.key_setting.remote_key)”| Name | Type | Constraint | Mandatory | Default Value |
|---|---|---|---|---|
| ip_address | String | No | ||
| port | Integer | min: 1, max: 65535 | No | |
| timeout | Integer | min: 1 | No | |
| enable_ | Boolean | true, false | No |
Examples
Section titled “Examples”Example-1: Drive Security Policy using a manual passphrase for local key management, with environment tags.
compute: intersight: organizations: - name: MyOrganization policies: drive_security: - name: drive-security-manual description: SED policy with manual passphrase key_setting: key_type: Manual manual_key: existing_key: !env DRIVE_SECURITY_EXISTING_KEY new_key: !env DRIVE_SECURITY_NEW_KEY tags: - key: env value: prodExample-2: Drive Security Policy using a remote KMIP server with authentication and a secondary failover server.
compute: intersight: organizations: - name: MyOrganization policies: drive_security: - name: drive-security-kmip description: SED policy with KMIP key management key_setting: key_type: Kmip remote_key: server_certificate: !env KMIP_SERVER_CA_CERT auth_credentials: use_authentication: true username: kmip-user password: !env KMIP_PASSWORD primary_server: ip_address: kmip01.example.com port: 5696 timeout: 60 enable_drive_security: true secondary_server: ip_address: kmip02.example.com port: 5696 timeout: 60 enable_drive_security: true