Kerberos Key Tab File¶

Overview¶

This document describes the API to configure a Kerberos Key Tab File and its properties in BIG-IQ.

REST Endpoint: /cm/access/working-config/apm/aaa/kerberos-keytab-file¶

Requests¶

GET /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>¶

Request Parameters¶

None

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name	Type	Description
checksum	string	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	Specify the revision of the file. Use the value from the create file object workflow.
size	number	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	Reference to the file location. Use the value from the create file object workflow.
link	string	URI link of the reference.
name	string	The name of the object
partition	string	The BIG-IP partition where the object should be placed
subPath	string	The BIG-IP folder where the object should be placed
deviceGroupReference	reference	Reference to the device group.
name	string	Name of the resource
kind	string	The kind of the resource.
link	string	URI link of the reference.
id	string	An ID of an application
kind	string	The kind of an application.
selfLink	string	The selfLink of an application.

Error Response¶

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A Detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions¶

Role	Allow
Application_Editor	Yes
Service_Catalog_Viewer	Yes
Service_Catalog_Editor	Yes
Trust_Discovery_Import	Yes
Access_View	Yes
Access_Edit	Yes
Access_Manager	Yes
Application_Manager	Yes
Application_Viewer	Yes
Trust_Discovery_Import	Yes
Access_Deploy	Yes
Access_Policy_Editor	Yes

POST /cm/access/working-config/apm/aaa/kerberos-keytab-file¶

Request Parameters¶

Name	Type	Required	Description
checksum	string	True	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	False	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	False	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	False	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	False	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	False	Specify the revision of the file. Use the value from the create file object workflow.
size	number	False	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	False	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	False	Reference to the file location. Use the value from the create file object workflow.
link	string	False	URI link of the reference.
name	string	True	The name of the object
partition	string	True	The BIG-IP partition where the object should be placed
subPath	string	False	The BIG-IP folder where the object should be placed
deviceGroupReference	reference	False	Reference to the device group.
link	string	False	URI link of the reference.

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name	Type	Description
checksum	string	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	Specify the revision of the file. Use the value from the create file object workflow.
size	number	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	Reference to the file location. Use the value from the create file object workflow.
link	string	URI link of the reference.
name	string	The name of the object
partition	string	The BIG-IP partition where the object should be placed
subPath	string	The BIG-IP folder where the object should be placed
deviceGroupReference	reference	Reference to the device group.
name	string	Name of the resource
kind	string	The kind of the resource.
link	string	URI link of the reference.
id	string	An ID of an application
kind	string	The kind of an application.
selfLink	string	The selfLink of an application.

Error Response¶

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A Detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions¶

Role	Allow
Application_Editor	No
Service_Catalog_Viewer	No
Service_Catalog_Editor	No
Trust_Discovery_Import	No
Access_View	No
Access_Edit	Yes
Access_Manager	Yes
Application_Manager	No
Application_Viewer	No
Trust_Discovery_Import	No
Access_Deploy	No
Access_Policy_Editor	No

PUT /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>¶

Request Parameters¶

Name	Type	Required	Description
checksum	string	True	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	False	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	False	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	True	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	False	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	False	Specify the revision of the file. Use the value from the create file object workflow.
size	number	True	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	False	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	True	Reference to the file location. Use the value from the create file object workflow.
link	string	False	URI link of the reference.
name	string	True	The name of the object
partition	string	False	The BIG-IP partition where the object should be placed
subPath	string	False	The BIG-IP folder where the object should be placed
deviceGroupReference	reference	False	Reference to the device group.
name	string	False	Name of the resource
kind	string	False	The kind of the resource.
link	string	False	URI link of the reference.
id	string	False	An ID of an application
kind	string	False	The kind of an application.
selfLink	string	False	The selfLink of an application.

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name	Type	Description
checksum	string	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	Specify the revision of the file. Use the value from the create file object workflow.
size	number	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	Reference to the file location. Use the value from the create file object workflow.
link	string	URI link of the reference.
name	string	The name of the object
partition	string	The BIG-IP partition where the object should be placed
subPath	string	The BIG-IP folder where the object should be placed
deviceGroupReference	reference	Reference to the device group.
name	string	Name of the resource
kind	string	The kind of the resource.
link	string	URI link of the reference.
id	string	An ID of an application
kind	string	The kind of an application.
selfLink	string	The selfLink of an application.

Error Response¶

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A Detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions¶

Role	Allow
Application_Editor	No
Service_Catalog_Viewer	No
Service_Catalog_Editor	No
Trust_Discovery_Import	No
Access_View	No
Access_Edit	Yes
Access_Manager	Yes
Application_Manager	No
Application_Viewer	No
Trust_Discovery_Import	No
Access_Deploy	No
Access_Policy_Editor	No

PATCH /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>¶

Request Parameters¶

Name	Type	Required	Description
checksum	string	False	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	False	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	False	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	False	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	False	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	False	Specify the revision of the file. Use the value from the create file object workflow.
size	number	False	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	False	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	False	Reference to the file location. Use the value from the create file object workflow.
link	string	False	URI link of the reference.

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name	Type	Description
checksum	string	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	Specify the revision of the file. Use the value from the create file object workflow.
size	number	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	Reference to the file location. Use the value from the create file object workflow.
link	string	URI link of the reference.
name	string	The name of the object
partition	string	The BIG-IP partition where the object should be placed
subPath	string	The BIG-IP folder where the object should be placed
deviceGroupReference	reference	Reference to the device group.
name	string	Name of the resource
kind	string	The kind of the resource.
link	string	URI link of the reference.
id	string	An ID of an application
kind	string	The kind of an application.
selfLink	string	The selfLink of an application.

Error Response¶

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A Detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions¶

Role	Allow
Application_Editor	No
Service_Catalog_Viewer	No
Service_Catalog_Editor	No
Trust_Discovery_Import	No
Access_View	No
Access_Edit	Yes
Access_Manager	Yes
Application_Manager	No
Application_Viewer	No
Trust_Discovery_Import	No
Access_Deploy	No
Access_Policy_Editor	No

DELETE /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>¶

Request Parameters¶

None

Query Parameters¶

None

Response¶

HTTP/1.1 200 OK

Name	Type	Description
checksum	string	Specify the Checksum of the file. Use the value from the create file object workflow.
createTime	string	Specify the created time of the file. Use the value from the create file object workflow.
createdBy	string	Specifies who created this file. Use the value from the create file object workflow.
lastUpdateTime	string	Specify time of the file. Use the value from the create file object workflow. Time should be in ISO format.
mode	number	Specify the mode of the file. Use the value from the create file object workflow.
revision	number	Specify the revision of the file. Use the value from the create file object workflow.
size	number	Specify the size of the file. Use the value from the create file object workflow.
updatedBy	string	Specify who updated this file. Use the value from the create file object workflow.
fileReference	reference	Reference to the file location. Use the value from the create file object workflow.
link	string	URI link of the reference.
name	string	The name of the object
partition	string	The BIG-IP partition where the object should be placed
subPath	string	The BIG-IP folder where the object should be placed
deviceGroupReference	reference	Reference to the device group.
name	string	Name of the resource
kind	string	The kind of the resource.
link	string	URI link of the reference.
id	string	An ID of an application
kind	string	The kind of an application.
selfLink	string	The selfLink of an application.

Error Response¶

HTTP/1.1 400 Bad Request

This response status is related to error conditions. A Detailed error message displays in the response.

HTTP/1.1 401 Unauthorized

This response happens when access is denied due to invalid credentials(no Permission).

Permissions¶

Role	Allow
Application_Editor	No
Service_Catalog_Viewer	No
Service_Catalog_Editor	No
Trust_Discovery_Import	No
Access_View	No
Access_Edit	Yes
Access_Manager	Yes
Application_Manager	No
Application_Viewer	No
Trust_Discovery_Import	No
Access_Deploy	No
Access_Policy_Editor	No

Examples¶

Get Kerberos Key Tab File¶

GET /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>

Response¶

HTTP/1.1 200 OK
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "kind": "cm:access:working-config:apm:aaa:state",
    "selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
}

Create New Kerberos Key Tab File¶

POST /cm/access/working-config/apm/aaa/kerberos-keytab-file
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "deviceGroupReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
}

Response¶

HTTP/1.1 200 OK
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "kind": "cm:access:working-config:apm:aaa:state",
  "selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
}

Edit Kerberos Key Tab File¶

PUT /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "kind": "cm:access:working-config:apm:aaa:state",
    "selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
}

Response¶

HTTP/1.1 200 OK
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "kind": "cm:access:working-config:apm:aaa:state",
    "selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
}

Edit Kerberos Key Tab File¶

PATCH /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
}

Response¶

HTTP/1.1 200 OK
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "kind": "cm:access:working-config:apm:aaa:state",
  "selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
}

Delete Kerberos Key Tab File¶

DELETE /cm/access/working-config/apm/aaa/kerberos-keytab-file/<id>

Response¶

HTTP/1.1 200 OK
{
    "checksum": "SHA1:99:b84a8b3c88b993e10da5a6bc27212217337e1bd0",
    "createTime": "2016-10-20T22:38:14Z",
    "createdBy": "root",
    "lastUpdateTime": "2016-10-20T22:38:14Z",
    "mode": 33188,
    "revision": 1,
    "size": 99,
    "updatedBy": "root",
    "fileReference": {
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "name": "foo",
    "partition": "Common",
    "subPath": "/folder",
    "deviceGroupReference": {
        "name": "resourceName",
        "kind": "shared:resolver:device-groups:devicegroupstate",
        "link": "https://localhost/mgmt/shared/foo/bar/866cfd8a-4d03-48e9-ba94-bb21a4bc2346"
    },
    "id": "8f1fcb69-1f3c-3c0d-812e-af4fdde0ac11",
    "kind": "cm:access:working-config:apm:aaa:state",
  "selfLink": "https://localhost/mgmt/cm/access/working-config/apm/f0938680-57d5-377f-8c73-da4c2ce561ed"
}

Previous Next