TrueNAS uses DDP: https://github.com/meteor/meteor/blob/devel/packages/ddp/DDP.md .
DDP (Distributed Data Protocol) is the stateful websocket protocol to communicate between the client and the server.
Websocket endpoint: /websocket
e.g. ws://truenas.domain/websocket
connect
message.{
"msg": "connect",
"version": "1",
"support": ["1"]
}
connected
or failed
.{
"msg": "connected",
"session": "b4a4d164-6bc7-11e6-8a93-00e04d680384"
}
Authentication happens by calling the auth.login
method.
Request:
{
"id": "d8e715be-6bc7-11e6-8c28-00e04d680384",
"msg": "method",
"method": "auth.login",
"params": ["username", "password"]
}
Response:
{
"id": "d8e715be-6bc7-11e6-8c28-00e04d680384",
"msg": "result",
"result": true,
}
acme.dns.authenticator.authenticator_schemas |
---|
Return Arguments:
{
"_name_": "authenticator_schemas",
"title": "Authenticator Schemas",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"key": {
"_name_": "key",
"title": "key",
"_required_": true,
"type": "string"
},
"schema": {
"_name_": "schema",
"title": "schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"_name_": {
"_name_": "_name_",
"title": "_name_",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"_required_": {
"type": "boolean",
"_name_": "_required_",
"title": "_required_",
"_required_": true
}
},
"additionalProperties": true,
"_name_": "attribute_schema",
"title": "Attribute Schema",
"default": {},
"_required_": false,
"_attrs_order_": [
"_name_",
"title",
"_required_"
]
}
]
}
},
"additionalProperties": false,
"_name_": "schema_entry",
"title": "Authenticator Schema",
"default": {},
"_required_": false,
"_attrs_order_": [
"key",
"schema"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Get the schemas for all DNS providers we support for ACME DNS Challenge and the respective attributes required for connecting to them while validating a DNS Challenge |
acme.dns.authenticator.create |
---|
Arguments:
{
"type": "object",
"properties": {
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_create",
"title": "acme_dns_authenticator_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"authenticator",
"attributes",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_create_returns",
"title": "acme_dns_authenticator_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"authenticator",
"attributes",
"name"
]
}
|
Create a DNS Authenticator Create a specific DNS Authenticator containing required authentication details for the said provider to successfully connect with it |
Create a DNS Authenticator for Route53
|
acme.dns.authenticator.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete DNS Authenticator of `id`"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete DNS Authenticator of |
Delete a DNS Authenticator of
|
acme.dns.authenticator.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_entry",
"title": "acme_dns_authenticator_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"authenticator",
"attributes",
"name"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
acme.dns.authenticator.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_entry",
"title": "acme_dns_authenticator_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"authenticator",
"attributes",
"name"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_entry",
"title": "acme_dns_authenticator_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"authenticator",
"attributes",
"name"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_entry",
"title": "acme_dns_authenticator_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"authenticator",
"attributes",
"name"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
acme.dns.authenticator.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update DNS Authenticator of `id`"
}
{
"type": "object",
"properties": {
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "dns_authenticator_update",
"title": "dns_authenticator_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"attributes",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update DNS Authenticator of `id`"
},
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_update_returns",
"title": "acme_dns_authenticator_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"authenticator",
"attributes",
"name"
]
}
|
Update DNS Authenticator of |
Update a DNS Authenticator of
|
activedirectory.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"domainname": {
"_name_": "domainname",
"title": "domainname",
"_required_": true,
"type": "string"
},
"bindname": {
"_name_": "bindname",
"title": "bindname",
"_required_": false,
"type": "string"
},
"bindpw": {
"_name_": "bindpw",
"title": "bindpw",
"_required_": false,
"type": "string"
},
"verbose_logging": {
"type": "boolean",
"_name_": "verbose_logging",
"title": "verbose_logging",
"_required_": false
},
"use_default_domain": {
"type": "boolean",
"_name_": "use_default_domain",
"title": "use_default_domain",
"_required_": false
},
"allow_trusted_doms": {
"type": "boolean",
"_name_": "allow_trusted_doms",
"title": "allow_trusted_doms",
"_required_": false
},
"allow_dns_updates": {
"type": "boolean",
"_name_": "allow_dns_updates",
"title": "allow_dns_updates",
"_required_": false
},
"disable_freenas_cache": {
"type": "boolean",
"_name_": "disable_freenas_cache",
"title": "disable_freenas_cache",
"_required_": false
},
"restrict_pam": {
"type": "boolean",
"_name_": "restrict_pam",
"title": "restrict_pam",
"default": false,
"_required_": false
},
"site": {
"_name_": "site",
"title": "site",
"_required_": false,
"type": [
"string",
"null"
]
},
"kerberos_realm": {
"type": [
"integer",
"null"
],
"_name_": "kerberos_realm",
"title": "kerberos_realm",
"_required_": false
},
"kerberos_principal": {
"_name_": "kerberos_principal",
"title": "kerberos_principal",
"_required_": false,
"type": [
"string",
"null"
]
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 60,
"_required_": false
},
"dns_timeout": {
"type": "integer",
"_name_": "dns_timeout",
"title": "dns_timeout",
"default": 10,
"_required_": false
},
"nss_info": {
"_name_": "nss_info",
"title": "nss_info",
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"TEMPLATE",
"SFU",
"SFU20",
"RFC2307"
]
},
"createcomputer": {
"_name_": "createcomputer",
"title": "createcomputer",
"_required_": false,
"type": "string"
},
"netbiosname": {
"_name_": "netbiosname",
"title": "netbiosname",
"_required_": false,
"type": "string"
},
"netbiosname_b": {
"_name_": "netbiosname_b",
"title": "netbiosname_b",
"_required_": false,
"type": "string"
},
"netbiosalias": {
"_name_": "netbiosalias",
"title": "netbiosalias",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "alias",
"title": "alias",
"_required_": false,
"type": "string"
}
]
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "activedirectory_update",
"title": "activedirectory_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"domainname",
"bindname",
"bindpw",
"verbose_logging",
"use_default_domain",
"allow_trusted_doms",
"allow_dns_updates",
"disable_freenas_cache",
"restrict_pam",
"site",
"kerberos_realm",
"kerberos_principal",
"timeout",
"dns_timeout",
"nss_info",
"createcomputer",
"netbiosname",
"netbiosname_b",
"netbiosalias",
"enable"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
activedirectory.domain_info |
---|
Arguments:
{
"_name_": "domain",
"title": "domain",
"default": "",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"LDAP server": {
"_name_": "LDAP server",
"title": "LDAP server",
"_required_": false,
"type": "string"
},
"LDAP server name": {
"_name_": "LDAP server name",
"title": "LDAP server name",
"_required_": false,
"type": "string"
},
"Realm": {
"_name_": "Realm",
"title": "Realm",
"_required_": false,
"type": "string",
"description": "`Realm` Kerberos realm"
},
"Bind Path": {
"_name_": "Bind Path",
"title": "Bind Path",
"_required_": false,
"type": "string"
},
"LDAP port": {
"type": "integer",
"_name_": "LDAP port",
"title": "LDAP port",
"_required_": false
},
"Server time": {
"type": "integer",
"_name_": "Server time",
"title": "Server time",
"_required_": false
},
"KDC server": {
"_name_": "KDC server",
"title": "KDC server",
"_required_": false,
"type": "string"
},
"Server time offset": {
"type": "integer",
"_name_": "Server time offset",
"title": "Server time offset",
"_required_": false
},
"Last machine account password change": {
"type": "integer",
"_name_": "Last machine account password change",
"title": "Last machine account password change",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "domain_info",
"title": "domain_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"LDAP server",
"LDAP server name",
"Realm",
"Bind Path",
"LDAP port",
"Server time",
"KDC server",
"Server time offset",
"Last machine account password change"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns the following information about the currently joined domain:
|
activedirectory.leave
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "kerberos_username_password",
"title": "kerberos_username_password",
"default": {},
"_required_": false,
"_attrs_order_": [
"username",
"password"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Leave Active Directory domain. This will remove computer object from AD and clear relevant configuration data from the NAS. This requires credentials for appropriately-privileged user. Credentials are used to obtain a kerberos ticket, which is used to perform the actual removal from the domain. |
activedirectory.nss_info_choices |
---|
Return Arguments:
{
"_name_": "nss_info_ad",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns list of available LDAP schema choices. |
activedirectory.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"domainname": {
"_name_": "domainname",
"title": "domainname",
"_required_": true,
"type": "string",
"description": "`domainname` full DNS domain name of the Active Directory domain."
},
"bindname": {
"_name_": "bindname",
"title": "bindname",
"_required_": false,
"type": "string",
"description": "`bindname` username used to perform the intial domain join."
},
"bindpw": {
"_name_": "bindpw",
"title": "bindpw",
"_required_": false,
"type": "string",
"description": "`bindpw` password used to perform the initial domain join. User-\nprovided credentials are used to obtain a kerberos ticket, which\nis used to perform the actual domain join."
},
"verbose_logging": {
"type": "boolean",
"_name_": "verbose_logging",
"title": "verbose_logging",
"_required_": false,
"description": "`verbose_logging` increase logging during the domain join process."
},
"use_default_domain": {
"type": "boolean",
"_name_": "use_default_domain",
"title": "use_default_domain",
"_required_": false,
"description": "`use_default_domain` controls whether domain users and groups have\nthe pre-windows 2000 domain name prepended to the user account. When\nenabled, the user appears as \"administrator\" rather than\n\"EXAMPLE\u0007dministrator\""
},
"allow_trusted_doms": {
"type": "boolean",
"_name_": "allow_trusted_doms",
"title": "allow_trusted_doms",
"_required_": false,
"description": "`allow_trusted_doms` enable support for trusted domains. If this\nparameter is enabled, then separate idmap backends _must_ be configured\nfor each trusted domain, and the idmap cache should be cleared."
},
"allow_dns_updates": {
"type": "boolean",
"_name_": "allow_dns_updates",
"title": "allow_dns_updates",
"_required_": false,
"description": "`allow_dns_updates` during the domain join process, automatically\ngenerate DNS entries in the AD domain for the NAS. If this is disabled,\nthen a domain administrator must manually add appropriate DNS entries\nfor the NAS. This parameter is recommended for TrueNAS HA servers."
},
"disable_freenas_cache": {
"type": "boolean",
"_name_": "disable_freenas_cache",
"title": "disable_freenas_cache",
"_required_": false,
"description": "`disable_freenas_cache` disables active caching of AD users and groups.\nWhen disabled, only users cached in winbind's internal cache are\nvisible in GUI dropdowns. Disabling active caching is recommended\nin environments with a large amount of users."
},
"restrict_pam": {
"type": "boolean",
"_name_": "restrict_pam",
"title": "restrict_pam",
"default": false,
"_required_": false
},
"site": {
"_name_": "site",
"title": "site",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`site` AD site of which the NAS is a member. This parameter is auto-\ndetected during the domain join process. If no AD site is configured\nfor the subnet in which the NAS is configured, then this parameter\nappears as 'Default-First-Site-Name'. Auto-detection is only performed\nduring the initial domain join."
},
"kerberos_realm": {
"type": [
"integer",
"null"
],
"_name_": "kerberos_realm",
"title": "kerberos_realm",
"_required_": false,
"description": "`kerberos_realm` in which the server is located. This parameter is\nautomatically populated during the initial domain join. If the NAS has\nan AD site configured and that site has multiple kerberos servers, then\nthe kerberos realm is automatically updated with a site-specific\nconfiguration to use those servers. Auto-detection is only performed\nduring initial domain join."
},
"kerberos_principal": {
"_name_": "kerberos_principal",
"title": "kerberos_principal",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`kerberos_principal` kerberos principal to use for AD-related\noperations outside of Samba. After intial domain join, this field is\nupdated with the kerberos principal associated with the AD machine\naccount for the NAS."
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 60,
"_required_": false,
"description": "`timeout` timeout value for winbind-related operations. This value may\nneed to be increased in environments with high latencies for\ncommunications with domain controllers or a large number of domain\ncontrollers. Lowering the value may cause status checks to fail."
},
"dns_timeout": {
"type": "integer",
"_name_": "dns_timeout",
"title": "dns_timeout",
"default": 10,
"_required_": false,
"description": "`dns_timeout` timeout value for DNS queries during the initial domain\njoin. This value is also set as the NETWORK_TIMEOUT in the ldap config\nfile."
},
"nss_info": {
"_name_": "nss_info",
"title": "nss_info",
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"TEMPLATE",
"SFU",
"SFU20",
"RFC2307"
],
"description": "`nss_info` controls how Winbind retrieves Name Service Information to\nconstruct a user's home directory and login shell. This parameter\nis only effective if the Active Directory Domain Controller supports\nthe Microsoft Services for Unix (SFU) LDAP schema."
},
"createcomputer": {
"_name_": "createcomputer",
"title": "createcomputer",
"_required_": false,
"type": "string",
"description": "`createcomputer` Active Directory Organizational Unit in which new\ncomputer accounts are created."
},
"netbiosname": {
"_name_": "netbiosname",
"title": "netbiosname",
"_required_": false,
"type": "string"
},
"netbiosname_b": {
"_name_": "netbiosname_b",
"title": "netbiosname_b",
"_required_": false,
"type": "string"
},
"netbiosalias": {
"_name_": "netbiosalias",
"title": "netbiosalias",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "alias",
"title": "alias",
"_required_": false,
"type": "string"
}
]
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false,
"description": "The Active Directory service is started after a configuration\nupdate if the service was initially disabled, and the updated\nconfiguration sets `enable` to `True`. The Active Directory\nservice is stopped if `enable` is changed to `False`. If the\nconfiguration is updated, but the initial `enable` state is `True`, and\nremains unchanged, then the samba server is only restarted."
}
},
"additionalProperties": false,
"_name_": "activedirectory_update",
"title": "activedirectory_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"domainname",
"bindname",
"bindpw",
"verbose_logging",
"use_default_domain",
"allow_trusted_doms",
"allow_dns_updates",
"disable_freenas_cache",
"restrict_pam",
"site",
"kerberos_realm",
"kerberos_principal",
"timeout",
"dns_timeout",
"nss_info",
"createcomputer",
"netbiosname",
"netbiosname_b",
"netbiosalias",
"enable"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"domainname": {
"_name_": "domainname",
"title": "domainname",
"_required_": true,
"type": "string",
"description": "`domainname` full DNS domain name of the Active Directory domain."
},
"bindname": {
"_name_": "bindname",
"title": "bindname",
"_required_": false,
"type": "string",
"description": "`bindname` username used to perform the intial domain join."
},
"bindpw": {
"_name_": "bindpw",
"title": "bindpw",
"_required_": false,
"type": "string",
"description": "`bindpw` password used to perform the initial domain join. User-\nprovided credentials are used to obtain a kerberos ticket, which\nis used to perform the actual domain join."
},
"verbose_logging": {
"type": "boolean",
"_name_": "verbose_logging",
"title": "verbose_logging",
"_required_": false,
"description": "`verbose_logging` increase logging during the domain join process."
},
"use_default_domain": {
"type": "boolean",
"_name_": "use_default_domain",
"title": "use_default_domain",
"_required_": false,
"description": "`use_default_domain` controls whether domain users and groups have\nthe pre-windows 2000 domain name prepended to the user account. When\nenabled, the user appears as \"administrator\" rather than\n\"EXAMPLE\u0007dministrator\""
},
"allow_trusted_doms": {
"type": "boolean",
"_name_": "allow_trusted_doms",
"title": "allow_trusted_doms",
"_required_": false,
"description": "`allow_trusted_doms` enable support for trusted domains. If this\nparameter is enabled, then separate idmap backends _must_ be configured\nfor each trusted domain, and the idmap cache should be cleared."
},
"allow_dns_updates": {
"type": "boolean",
"_name_": "allow_dns_updates",
"title": "allow_dns_updates",
"_required_": false,
"description": "`allow_dns_updates` during the domain join process, automatically\ngenerate DNS entries in the AD domain for the NAS. If this is disabled,\nthen a domain administrator must manually add appropriate DNS entries\nfor the NAS. This parameter is recommended for TrueNAS HA servers."
},
"disable_freenas_cache": {
"type": "boolean",
"_name_": "disable_freenas_cache",
"title": "disable_freenas_cache",
"_required_": false,
"description": "`disable_freenas_cache` disables active caching of AD users and groups.\nWhen disabled, only users cached in winbind's internal cache are\nvisible in GUI dropdowns. Disabling active caching is recommended\nin environments with a large amount of users."
},
"restrict_pam": {
"type": "boolean",
"_name_": "restrict_pam",
"title": "restrict_pam",
"default": false,
"_required_": false
},
"site": {
"_name_": "site",
"title": "site",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`site` AD site of which the NAS is a member. This parameter is auto-\ndetected during the domain join process. If no AD site is configured\nfor the subnet in which the NAS is configured, then this parameter\nappears as 'Default-First-Site-Name'. Auto-detection is only performed\nduring the initial domain join."
},
"kerberos_realm": {
"type": [
"integer",
"null"
],
"_name_": "kerberos_realm",
"title": "kerberos_realm",
"_required_": false,
"description": "`kerberos_realm` in which the server is located. This parameter is\nautomatically populated during the initial domain join. If the NAS has\nan AD site configured and that site has multiple kerberos servers, then\nthe kerberos realm is automatically updated with a site-specific\nconfiguration to use those servers. Auto-detection is only performed\nduring initial domain join."
},
"kerberos_principal": {
"_name_": "kerberos_principal",
"title": "kerberos_principal",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`kerberos_principal` kerberos principal to use for AD-related\noperations outside of Samba. After intial domain join, this field is\nupdated with the kerberos principal associated with the AD machine\naccount for the NAS."
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 60,
"_required_": false,
"description": "`timeout` timeout value for winbind-related operations. This value may\nneed to be increased in environments with high latencies for\ncommunications with domain controllers or a large number of domain\ncontrollers. Lowering the value may cause status checks to fail."
},
"dns_timeout": {
"type": "integer",
"_name_": "dns_timeout",
"title": "dns_timeout",
"default": 10,
"_required_": false,
"description": "`dns_timeout` timeout value for DNS queries during the initial domain\njoin. This value is also set as the NETWORK_TIMEOUT in the ldap config\nfile."
},
"nss_info": {
"_name_": "nss_info",
"title": "nss_info",
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"TEMPLATE",
"SFU",
"SFU20",
"RFC2307"
],
"description": "`nss_info` controls how Winbind retrieves Name Service Information to\nconstruct a user's home directory and login shell. This parameter\nis only effective if the Active Directory Domain Controller supports\nthe Microsoft Services for Unix (SFU) LDAP schema."
},
"createcomputer": {
"_name_": "createcomputer",
"title": "createcomputer",
"_required_": false,
"type": "string",
"description": "`createcomputer` Active Directory Organizational Unit in which new\ncomputer accounts are created."
},
"netbiosname": {
"_name_": "netbiosname",
"title": "netbiosname",
"_required_": false,
"type": "string"
},
"netbiosname_b": {
"_name_": "netbiosname_b",
"title": "netbiosname_b",
"_required_": false,
"type": "string"
},
"netbiosalias": {
"_name_": "netbiosalias",
"title": "netbiosalias",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "alias",
"title": "alias",
"_required_": false,
"type": "string"
}
]
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false,
"description": "The Active Directory service is started after a configuration\nupdate if the service was initially disabled, and the updated\nconfiguration sets `enable` to `True`. The Active Directory\nservice is stopped if `enable` is changed to `False`. If the\nconfiguration is updated, but the initial `enable` state is `True`, and\nremains unchanged, then the samba server is only restarted."
}
},
"additionalProperties": false,
"_name_": "activedirectory_update",
"title": "activedirectory_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"domainname",
"bindname",
"bindpw",
"verbose_logging",
"use_default_domain",
"allow_trusted_doms",
"allow_dns_updates",
"disable_freenas_cache",
"restrict_pam",
"site",
"kerberos_realm",
"kerberos_principal",
"timeout",
"dns_timeout",
"nss_info",
"createcomputer",
"netbiosname",
"netbiosname_b",
"netbiosalias",
"enable"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Update active directory configuration.
The OU string is read from top to bottom without RDNs. Slashes ("/")
are used as delimiters, like When this field is blank, new computer accounts are created in the Active Directory default OU. The Active Directory service is started after a configuration
update if the service was initially disabled, and the updated
configuration sets During the domain join, a kerberos keytab for the newly-created AD machine account is generated. It is used for all future LDAP / AD interaction and the user-provided credentials are removed. |
alert.dismiss |
---|
Arguments:
{
"_name_": "uuid",
"title": "uuid",
"_required_": false,
"type": "string"
}
|
Dismiss |
alert.list |
---|
Return Arguments:
{
"_name_": "alerts",
"title": "alerts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"uuid": {
"_name_": "uuid",
"title": "uuid",
"_required_": false,
"type": "string"
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"klass": {
"_name_": "klass",
"title": "klass",
"_required_": false,
"type": "string"
},
"args": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "args",
"title": "args",
"_required_": false
},
"node": {
"_name_": "node",
"title": "node",
"_required_": false,
"type": "string"
},
"key": {
"_name_": "key",
"title": "key",
"_required_": false,
"type": "string"
},
"datetime": {
"_name_": "datetime",
"title": "datetime",
"_required_": false,
"type": "string"
},
"last_occurrence": {
"_name_": "last_occurrence",
"title": "last_occurrence",
"_required_": false,
"type": "string"
},
"dismissed": {
"type": "boolean",
"_name_": "dismissed",
"title": "dismissed",
"_required_": false
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "mail",
"title": "mail",
"_required_": false
},
"text": {
"_name_": "text",
"title": "text",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"level": {
"_name_": "level",
"title": "level",
"_required_": false,
"type": "string"
},
"formatted": {
"_name_": "formatted",
"title": "formatted",
"_required_": false,
"type": [
"string",
"null"
]
},
"one_shot": {
"type": "boolean",
"_name_": "one_shot",
"title": "one_shot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "alert",
"title": "alert",
"default": {},
"_required_": false,
"_attrs_order_": [
"uuid",
"source",
"klass",
"args",
"node",
"key",
"datetime",
"last_occurrence",
"dismissed",
"mail",
"text",
"id",
"level",
"formatted",
"one_shot"
]
}
]
}
|
This method is accessible to the users granted with the following roles: ALERT_LIST_READ, READONLY_ADMIN, SHARING_ADMIN |
List all types of alerts including active/dismissed currently in the system. |
alert.list_categories |
---|
Return Arguments:
{
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"classes": {
"_name_": "classes",
"title": "classes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"level": {
"_name_": "level",
"title": "level",
"_required_": false,
"type": "string"
},
"proactive_support": {
"type": "boolean",
"_name_": "proactive_support",
"title": "proactive_support",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "category_class",
"title": "category_class",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"title",
"level",
"proactive_support"
]
}
]
}
},
"additionalProperties": false,
"_name_": "category",
"title": "category",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"title",
"classes"
]
}
]
}
|
This method is accessible to the users granted with the following roles: ALERT_LIST_READ, READONLY_ADMIN, SHARING_ADMIN |
List all types of alerts which the system can issue. |
alert.list_policies |
---|
Return Arguments:
{
"_name_": "alert_policies",
"title": "alert_policies",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "policy",
"title": "policy",
"_required_": false,
"type": "string",
"enum": [
"IMMEDIATELY",
"HOURLY",
"DAILY",
"NEVER"
]
}
]
}
|
This method is accessible to the users granted with the following roles: ALERT_LIST_READ, READONLY_ADMIN, SHARING_ADMIN |
List all alert policies which indicate the frequency of the alerts. |
alert.restore |
---|
Arguments:
{
"_name_": "uuid",
"title": "uuid",
"_required_": false,
"type": "string"
}
|
Restore |
alertclasses.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"classes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "classes",
"title": "classes",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "alertclasses_entry",
"title": "alertclasses_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"classes"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
alertclasses.update |
---|
Arguments:
{
"type": "object",
"properties": {
"classes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "classes",
"title": "classes",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "alertclasses_update",
"title": "alertclasses_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"classes"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"classes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "classes",
"title": "classes",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "alertclasses_update_returns",
"title": "alertclasses_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"classes"
]
}
|
Update default Alert settings. |
alertservice.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "Create an Alert Service of specified `type`.\nIf `enabled`, it sends alerts to the configured `type` of Alert Service."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false,
"description": "If `enabled`, it sends alerts to the configured `type` of Alert Service."
}
},
"additionalProperties": false,
"_name_": "alert_service_create",
"title": "alert_service_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "Create an Alert Service of specified `type`.\nIf `enabled`, it sends alerts to the configured `type` of Alert Service."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false,
"description": "If `enabled`, it sends alerts to the configured `type` of Alert Service."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type__title": {
"_name_": "type__title",
"title": "type__title",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alertservice_create_returns",
"title": "alertservice_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled",
"id",
"type__title"
]
}
|
Create an Alert Service of specified If |
Create an Alert Service of Mail
|
alertservice.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete Alert Service of |
alertservice.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"type__title": {
"_name_": "type__title",
"title": "type__title",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alertservice_entry",
"title": "alertservice_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled",
"id",
"type__title"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
alertservice.list_types |
---|
Return Arguments:
{
"_name_": "alert_service_types",
"title": "alert_service_types",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alert_service_type",
"title": "alert_service_type",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"title"
]
}
]
}
|
List all types of supported Alert services which can be configured with the system. |
alertservice.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type__title": {
"_name_": "type__title",
"title": "type__title",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alertservice_entry",
"title": "alertservice_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled",
"id",
"type__title"
]
}
]
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type__title": {
"_name_": "type__title",
"title": "type__title",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alertservice_entry",
"title": "alertservice_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled",
"id",
"type__title"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type__title": {
"_name_": "type__title",
"title": "type__title",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alertservice_entry",
"title": "alertservice_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled",
"id",
"type__title"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
alertservice.test |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "Send a test alert using `type` of Alert Service."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "alert_service_create",
"title": "alert_service_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successful_test",
"title": "successful_test",
"description": "Is `true` if test is successful",
"_required_": false
}
|
Send a test alert using |
Send a test alert using Alert Service of Mail
|
alertservice.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Alert Service of `id`."
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "Create an Alert Service of specified `type`.\nIf `enabled`, it sends alerts to the configured `type` of Alert Service.\n Create an Alert Service of Mail `type`"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false,
"description": "If `enabled`, it sends alerts to the configured `type` of Alert Service."
}
},
"additionalProperties": false,
"_name_": "alert_service_update",
"title": "alert_service_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "Create an Alert Service of specified `type`.\nIf `enabled`, it sends alerts to the configured `type` of Alert Service.\n Create an Alert Service of Mail `type`"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false,
"description": "If `enabled`, it sends alerts to the configured `type` of Alert Service."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Alert Service of `id`."
},
"type__title": {
"_name_": "type__title",
"title": "type__title",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alertservice_update_returns",
"title": "alertservice_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled",
"id",
"type__title"
]
}
|
Update Alert Service of |
api_key.create |
---|
Arguments:
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"allowlist": {
"items": [
{
"additionalProperties": false,
"properties": {
"method": {
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
],
"title": "method",
"type": "string",
"_name_": "method",
"_required_": true
},
"resource": {
"minLength": 1,
"title": "resource",
"type": "string",
"_name_": "resource",
"_required_": true
}
},
"required": [
"method",
"resource"
],
"title": "AllowListItem",
"type": "object",
"_attrs_order_": [
"method",
"resource"
]
}
],
"title": "allowlist",
"type": "array",
"_name_": "allowlist",
"_required_": true
}
},
"required": [
"name",
"allowlist"
],
"title": "api_key_create",
"type": "object",
"_name_": "api_key_create",
"_required_": true,
"_attrs_order_": [
"name",
"allowlist"
]
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"name": {
"maxLength": 200,
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"created_at": {
"format": "date-time",
"title": "created_at",
"type": "string",
"_name_": "created_at",
"_required_": true
},
"allowlist": {
"items": [
{
"additionalProperties": false,
"properties": {
"method": {
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
],
"title": "method",
"type": "string",
"_name_": "method",
"_required_": true
},
"resource": {
"minLength": 1,
"title": "resource",
"type": "string",
"_name_": "resource",
"_required_": true
}
},
"required": [
"method",
"resource"
],
"title": "AllowListItem",
"type": "object",
"_attrs_order_": [
"method",
"resource"
]
}
],
"title": "allowlist",
"type": "array",
"_name_": "allowlist",
"_required_": true
},
"key": {
"title": "key",
"type": "string",
"_name_": "key",
"_required_": true
}
},
"required": [
"id",
"name",
"created_at",
"allowlist",
"key"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"id",
"name",
"created_at",
"allowlist",
"key"
]
}
|
Creates API Key.
|
api_key.delete |
---|
Arguments:
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
}
|
Return Arguments:
{
"const": true,
"enum": [
true
],
"title": "result",
"type": "boolean",
"_name_": "result",
"_required_": true
}
|
Delete API Key |
api_key.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "api_key_entry",
"title": "api_key_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
api_key.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "api_key_entry",
"title": "api_key_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "api_key_entry",
"title": "api_key_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "api_key_entry",
"title": "api_key_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
api_key.update |
---|
Arguments:
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
}
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": false
},
"allowlist": {
"items": [
{
"additionalProperties": false,
"properties": {
"method": {
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
],
"title": "method",
"type": "string",
"_name_": "method",
"_required_": true
},
"resource": {
"minLength": 1,
"title": "resource",
"type": "string",
"_name_": "resource",
"_required_": true
}
},
"required": [
"method",
"resource"
],
"title": "AllowListItem",
"type": "object",
"_attrs_order_": [
"method",
"resource"
]
}
],
"title": "allowlist",
"type": "array",
"_name_": "allowlist",
"_required_": false
},
"reset": {
"title": "reset",
"type": "boolean",
"_name_": "reset",
"_required_": false
}
},
"title": "api_key_update",
"type": "object",
"_name_": "api_key_update",
"_required_": true,
"_attrs_order_": [
"name",
"allowlist",
"reset"
]
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"name": {
"maxLength": 200,
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"created_at": {
"format": "date-time",
"title": "created_at",
"type": "string",
"_name_": "created_at",
"_required_": true
},
"allowlist": {
"items": [
{
"additionalProperties": false,
"properties": {
"method": {
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
],
"title": "method",
"type": "string",
"_name_": "method",
"_required_": true
},
"resource": {
"minLength": 1,
"title": "resource",
"type": "string",
"_name_": "resource",
"_required_": true
}
},
"required": [
"method",
"resource"
],
"title": "AllowListItem",
"type": "object",
"_attrs_order_": [
"method",
"resource"
]
}
],
"title": "allowlist",
"type": "array",
"_name_": "allowlist",
"_required_": true
},
"key": {
"title": "key",
"type": "string",
"_name_": "key",
"_required_": true
}
},
"required": [
"id",
"name",
"created_at",
"allowlist",
"key"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"id",
"name",
"created_at",
"allowlist",
"key"
]
}
|
Update API Key Specify |
app.available |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"installed": {
"type": "boolean",
"_name_": "installed",
"title": "installed",
"_required_": true
},
"recommended": {
"type": "boolean",
"_name_": "recommended",
"title": "recommended",
"_required_": true
},
"last_update": {
"_name_": "last_update",
"title": "last_update",
"_required_": true,
"type": "string"
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"run_as_context": {
"_name_": "run_as_context",
"title": "run_as_context",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"categories": {
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"maintainers": {
"_name_": "maintainers",
"title": "maintainers",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"tags": {
"_name_": "tags",
"title": "tags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"screenshots": {
"_name_": "screenshots",
"title": "screenshots",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "screenshot",
"title": "screenshot",
"_required_": false,
"type": "string"
}
]
},
"sources": {
"_name_": "sources",
"title": "sources",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
}
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"app_readme": {
"_name_": "app_readme",
"title": "app_readme",
"_required_": true,
"type": "string"
},
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"healthy_error": {
"_name_": "healthy_error",
"title": "healthy_error",
"_required_": true,
"type": [
"string",
"null"
]
},
"home": {
"_name_": "home",
"title": "home",
"_required_": true,
"type": "string"
},
"latest_version": {
"_name_": "latest_version",
"title": "latest_version",
"_required_": true,
"type": "string"
},
"latest_app_version": {
"_name_": "latest_app_version",
"title": "latest_app_version",
"_required_": true,
"type": "string"
},
"latest_human_version": {
"_name_": "latest_human_version",
"title": "latest_human_version",
"_required_": true,
"type": "string"
},
"icon_url": {
"_name_": "icon_url",
"title": "icon_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"train": {
"_name_": "train",
"title": "train",
"_required_": true,
"type": "string"
},
"catalog": {
"_name_": "catalog",
"title": "catalog",
"_required_": true,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "available_apps",
"title": "available_apps",
"default": {},
"_required_": false,
"_attrs_order_": [
"healthy",
"installed",
"recommended",
"last_update",
"capabilities",
"run_as_context",
"categories",
"maintainers",
"tags",
"screenshots",
"sources",
"name",
"title",
"description",
"app_readme",
"location",
"healthy_error",
"home",
"latest_version",
"latest_app_version",
"latest_human_version",
"icon_url",
"train",
"catalog"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"installed": {
"type": "boolean",
"_name_": "installed",
"title": "installed",
"_required_": true
},
"recommended": {
"type": "boolean",
"_name_": "recommended",
"title": "recommended",
"_required_": true
},
"last_update": {
"_name_": "last_update",
"title": "last_update",
"_required_": true,
"type": "string"
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"run_as_context": {
"_name_": "run_as_context",
"title": "run_as_context",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"categories": {
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"maintainers": {
"_name_": "maintainers",
"title": "maintainers",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"tags": {
"_name_": "tags",
"title": "tags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"screenshots": {
"_name_": "screenshots",
"title": "screenshots",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "screenshot",
"title": "screenshot",
"_required_": false,
"type": "string"
}
]
},
"sources": {
"_name_": "sources",
"title": "sources",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
}
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"app_readme": {
"_name_": "app_readme",
"title": "app_readme",
"_required_": true,
"type": "string"
},
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"healthy_error": {
"_name_": "healthy_error",
"title": "healthy_error",
"_required_": true,
"type": [
"string",
"null"
]
},
"home": {
"_name_": "home",
"title": "home",
"_required_": true,
"type": "string"
},
"latest_version": {
"_name_": "latest_version",
"title": "latest_version",
"_required_": true,
"type": "string"
},
"latest_app_version": {
"_name_": "latest_app_version",
"title": "latest_app_version",
"_required_": true,
"type": "string"
},
"latest_human_version": {
"_name_": "latest_human_version",
"title": "latest_human_version",
"_required_": true,
"type": "string"
},
"icon_url": {
"_name_": "icon_url",
"title": "icon_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"train": {
"_name_": "train",
"title": "train",
"_required_": true,
"type": "string"
},
"catalog": {
"_name_": "catalog",
"title": "catalog",
"_required_": true,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "available_apps",
"title": "available_apps",
"default": {},
"_required_": false,
"_attrs_order_": [
"healthy",
"installed",
"recommended",
"last_update",
"capabilities",
"run_as_context",
"categories",
"maintainers",
"tags",
"screenshots",
"sources",
"name",
"title",
"description",
"app_readme",
"location",
"healthy_error",
"home",
"latest_version",
"latest_app_version",
"latest_human_version",
"icon_url",
"train",
"catalog"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve all available applications from all configured catalogs. |
app.available_space |
---|
Return Arguments:
{
"type": "integer",
"_name_": "available_space",
"title": "available_space",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns space available in bytes in the configured apps pool which apps can consume |
app.categories |
---|
Return Arguments:
{
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "category",
"title": "category",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve list of valid categories which have associated applications. |
app.certificate_authority_choices |
---|
Return Arguments:
{
"_name_": "certificate_authority_choices",
"title": "certificate_authority_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns certificate authorities which can be used by applications. |
app.certificate_choices |
---|
Return Arguments:
{
"_name_": "certificate_choices",
"title": "certificate_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns certificates which can be used by applications. |
app.config |
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "app_config",
"title": "app_config",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve user specified configuration of |
app.container_console_choices |
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "container_console_choices",
"title": "container_console_choices",
"description": "\n\nExample(s):\n```\n{\n \"afb901dc53a29016c385a9de43f089117e399622c042674f82c10c911848baba\": {\n \"service_name\": \"jellyfin\",\n \"image\": \"jellyfin/jellyfin:10.9.7\",\n \"state\": \"running\",\n \"id\": \"afb901dc53a29016c385a9de43f089117e399622c042674f82c10c911848baba\"\n }\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns container console choices for |
app.container_ids |
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"alive_only": {
"type": "boolean",
"_name_": "alive_only",
"title": "alive_only",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"alive_only"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "container_ids",
"title": "container_ids",
"description": "\n\nExample(s):\n```\n{\n \"afb901dc53a29016c385a9de43f089117e399622c042674f82c10c911848baba\": {\n \"service_name\": \"jellyfin\",\n \"image\": \"jellyfin/jellyfin:10.9.7\",\n \"state\": \"running\",\n \"id\": \"afb901dc53a29016c385a9de43f089117e399622c042674f82c10c911848baba\"\n }\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns container IDs for |
app.convert_to_custom
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Convert |
app.create
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"custom_app": {
"type": "boolean",
"_name_": "custom_app",
"title": "custom_app",
"default": false,
"_required_": false
},
"values": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "values",
"title": "values",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"custom_compose_config": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "custom_compose_config",
"title": "custom_compose_config",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"custom_compose_config_string": {
"_name_": "custom_compose_config_string",
"title": "custom_compose_config_string",
"_required_": false,
"type": "string"
},
"catalog_app": {
"_name_": "catalog_app",
"title": "catalog_app",
"_required_": false,
"type": "string",
"description": "Create an app with `app_name` using `catalog_app` with `train` and `version`."
},
"app_name": {
"_name_": "app_name",
"title": "app_name",
"_required_": true,
"type": "string",
"description": "Create an app with `app_name` using `catalog_app` with `train` and `version`."
},
"train": {
"_name_": "train",
"title": "train",
"default": "stable",
"_required_": false,
"type": "string",
"description": "Create an app with `app_name` using `catalog_app` with `train` and `version`."
},
"version": {
"_name_": "version",
"title": "version",
"default": "latest",
"_required_": false,
"type": "string",
"description": "Create an app with `app_name` using `catalog_app` with `train` and `version`."
}
},
"additionalProperties": false,
"_name_": "app_create",
"title": "app_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"custom_app",
"values",
"custom_compose_config",
"custom_compose_config_string",
"catalog_app",
"app_name",
"train",
"version"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string",
"description": "Create an app with `app_name` using `catalog_app` with `train` and `version`."
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_create_returns",
"title": "app_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Create an app with TODO: Add support for advanced mode which will enable users to use their own compose files |
app.delete
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"remove_images": {
"type": "boolean",
"_name_": "remove_images",
"title": "remove_images",
"default": true,
"_required_": false
},
"remove_ix_volumes": {
"type": "boolean",
"_name_": "remove_ix_volumes",
"title": "remove_ix_volumes",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"remove_images",
"remove_ix_volumes"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Delete |
app.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
app.gpu_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "gpu_choices",
"title": "gpu_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns GPU choices which can be used by applications. |
app.ip_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"ip_choice": {
"_name_": "ip_choice",
"title": "ip_choice",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ip_choices",
"title": "ip_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"ip_choice"
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns IP choices which can be used by applications. |
app.latest |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"installed": {
"type": "boolean",
"_name_": "installed",
"title": "installed",
"_required_": true
},
"recommended": {
"type": "boolean",
"_name_": "recommended",
"title": "recommended",
"_required_": true
},
"last_update": {
"_name_": "last_update",
"title": "last_update",
"_required_": true,
"type": "string"
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"run_as_context": {
"_name_": "run_as_context",
"title": "run_as_context",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"categories": {
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"maintainers": {
"_name_": "maintainers",
"title": "maintainers",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"tags": {
"_name_": "tags",
"title": "tags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"screenshots": {
"_name_": "screenshots",
"title": "screenshots",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "screenshot",
"title": "screenshot",
"_required_": false,
"type": "string"
}
]
},
"sources": {
"_name_": "sources",
"title": "sources",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
}
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"app_readme": {
"_name_": "app_readme",
"title": "app_readme",
"_required_": true,
"type": "string"
},
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"healthy_error": {
"_name_": "healthy_error",
"title": "healthy_error",
"_required_": true,
"type": [
"string",
"null"
]
},
"home": {
"_name_": "home",
"title": "home",
"_required_": true,
"type": "string"
},
"latest_version": {
"_name_": "latest_version",
"title": "latest_version",
"_required_": true,
"type": "string"
},
"latest_app_version": {
"_name_": "latest_app_version",
"title": "latest_app_version",
"_required_": true,
"type": "string"
},
"latest_human_version": {
"_name_": "latest_human_version",
"title": "latest_human_version",
"_required_": true,
"type": "string"
},
"icon_url": {
"_name_": "icon_url",
"title": "icon_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"train": {
"_name_": "train",
"title": "train",
"_required_": true,
"type": "string"
},
"catalog": {
"_name_": "catalog",
"title": "catalog",
"_required_": true,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "available_apps",
"title": "available_apps",
"default": {},
"_required_": false,
"_attrs_order_": [
"healthy",
"installed",
"recommended",
"last_update",
"capabilities",
"run_as_context",
"categories",
"maintainers",
"tags",
"screenshots",
"sources",
"name",
"title",
"description",
"app_readme",
"location",
"healthy_error",
"home",
"latest_version",
"latest_app_version",
"latest_human_version",
"icon_url",
"train",
"catalog"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"installed": {
"type": "boolean",
"_name_": "installed",
"title": "installed",
"_required_": true
},
"recommended": {
"type": "boolean",
"_name_": "recommended",
"title": "recommended",
"_required_": true
},
"last_update": {
"_name_": "last_update",
"title": "last_update",
"_required_": true,
"type": "string"
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"run_as_context": {
"_name_": "run_as_context",
"title": "run_as_context",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"categories": {
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"maintainers": {
"_name_": "maintainers",
"title": "maintainers",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"tags": {
"_name_": "tags",
"title": "tags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"screenshots": {
"_name_": "screenshots",
"title": "screenshots",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "screenshot",
"title": "screenshot",
"_required_": false,
"type": "string"
}
]
},
"sources": {
"_name_": "sources",
"title": "sources",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
}
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"app_readme": {
"_name_": "app_readme",
"title": "app_readme",
"_required_": true,
"type": "string"
},
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"healthy_error": {
"_name_": "healthy_error",
"title": "healthy_error",
"_required_": true,
"type": [
"string",
"null"
]
},
"home": {
"_name_": "home",
"title": "home",
"_required_": true,
"type": "string"
},
"latest_version": {
"_name_": "latest_version",
"title": "latest_version",
"_required_": true,
"type": "string"
},
"latest_app_version": {
"_name_": "latest_app_version",
"title": "latest_app_version",
"_required_": true,
"type": "string"
},
"latest_human_version": {
"_name_": "latest_human_version",
"title": "latest_human_version",
"_required_": true,
"type": "string"
},
"icon_url": {
"_name_": "icon_url",
"title": "icon_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"train": {
"_name_": "train",
"title": "train",
"_required_": true,
"type": "string"
},
"catalog": {
"_name_": "catalog",
"title": "catalog",
"_required_": true,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "available_apps",
"title": "available_apps",
"default": {},
"_required_": false,
"_attrs_order_": [
"healthy",
"installed",
"recommended",
"last_update",
"capabilities",
"run_as_context",
"categories",
"maintainers",
"tags",
"screenshots",
"sources",
"name",
"title",
"description",
"app_readme",
"location",
"healthy_error",
"home",
"latest_version",
"latest_app_version",
"latest_human_version",
"icon_url",
"train",
"catalog"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve latest updated apps. |
app.outdated_docker_images |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "images",
"title": "images",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns a list of outdated docker images for the specified app |
app.pull_images
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"redeploy": {
"type": "boolean",
"_name_": "redeploy",
"title": "redeploy",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"redeploy"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Pulls docker images for the specified app |
app.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
]
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query all apps with
|
app.redeploy
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Redeploy |
app.rollback
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"app_version": {
"_name_": "app_version",
"title": "app_version",
"_required_": true,
"type": "string"
},
"rollback_snapshot": {
"type": "boolean",
"_name_": "rollback_snapshot",
"title": "rollback_snapshot",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"app_version",
"rollback_snapshot"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Rollback |
app.rollback_versions |
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "rollback_versions",
"title": "rollback_versions",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve versions available for rollback for |
app.similar |
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
{
"_name_": "train",
"title": "train",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "similar",
"title": "similar",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"installed": {
"type": "boolean",
"_name_": "installed",
"title": "installed",
"_required_": true
},
"recommended": {
"type": "boolean",
"_name_": "recommended",
"title": "recommended",
"_required_": true
},
"last_update": {
"_name_": "last_update",
"title": "last_update",
"_required_": true,
"type": "string"
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"run_as_context": {
"_name_": "run_as_context",
"title": "run_as_context",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"categories": {
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"maintainers": {
"_name_": "maintainers",
"title": "maintainers",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"tags": {
"_name_": "tags",
"title": "tags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"screenshots": {
"_name_": "screenshots",
"title": "screenshots",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "screenshot",
"title": "screenshot",
"_required_": false,
"type": "string"
}
]
},
"sources": {
"_name_": "sources",
"title": "sources",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
}
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"app_readme": {
"_name_": "app_readme",
"title": "app_readme",
"_required_": true,
"type": "string"
},
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"healthy_error": {
"_name_": "healthy_error",
"title": "healthy_error",
"_required_": true,
"type": [
"string",
"null"
]
},
"home": {
"_name_": "home",
"title": "home",
"_required_": true,
"type": "string"
},
"latest_version": {
"_name_": "latest_version",
"title": "latest_version",
"_required_": true,
"type": "string"
},
"latest_app_version": {
"_name_": "latest_app_version",
"title": "latest_app_version",
"_required_": true,
"type": "string"
},
"latest_human_version": {
"_name_": "latest_human_version",
"title": "latest_human_version",
"_required_": true,
"type": "string"
},
"icon_url": {
"_name_": "icon_url",
"title": "icon_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"train": {
"_name_": "train",
"title": "train",
"_required_": true,
"type": "string"
},
"catalog": {
"_name_": "catalog",
"title": "catalog",
"_required_": true,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "available_apps",
"title": "available_apps",
"default": {},
"_required_": false,
"_attrs_order_": [
"healthy",
"installed",
"recommended",
"last_update",
"capabilities",
"run_as_context",
"categories",
"maintainers",
"tags",
"screenshots",
"sources",
"name",
"title",
"description",
"app_readme",
"location",
"healthy_error",
"home",
"latest_version",
"latest_app_version",
"latest_human_version",
"icon_url",
"train",
"catalog"
]
}
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve applications which are similar to |
app.start
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Start |
app.stop
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Stop |
app.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string",
"description": "Update `app_name` app with new configuration.\nCreate an app with `app_name` using `catalog_app` with `train` and `version`."
}
{
"type": "object",
"properties": {
"values": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "values",
"title": "values",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"custom_compose_config": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "custom_compose_config",
"title": "custom_compose_config",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"custom_compose_config_string": {
"_name_": "custom_compose_config_string",
"title": "custom_compose_config_string",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "app_update",
"title": "app_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"values",
"custom_compose_config",
"custom_compose_config_string"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string",
"description": "Create an app with `app_name` using `catalog_app` with `train` and `version`."
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_update_returns",
"title": "app_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Update |
app.upgrade
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"values": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "values",
"title": "values",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"app_version": {
"_name_": "app_version",
"title": "app_version",
"default": "latest",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"values",
"app_version"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Upgrade |
app.upgrade_summary |
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"app_version": {
"_name_": "app_version",
"title": "app_version",
"default": "latest",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"app_version"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"latest_version": {
"_name_": "latest_version",
"title": "latest_version",
"description": "Latest version available for the app",
"_required_": false,
"type": "string"
},
"latest_human_version": {
"_name_": "latest_human_version",
"title": "latest_human_version",
"description": "Latest human readable version available for the app",
"_required_": false,
"type": "string"
},
"upgrade_version": {
"_name_": "upgrade_version",
"title": "upgrade_version",
"description": "Version user has requested to be upgraded at",
"_required_": false,
"type": "string"
},
"upgrade_human_version": {
"_name_": "upgrade_human_version",
"title": "upgrade_human_version",
"description": "Human readable version user has requested to be upgraded at",
"_required_": false,
"type": "string"
},
"changelog": {
"_name_": "changelog",
"title": "changelog",
"description": "Changelog for the upgrade version",
"_required_": false,
"type": [
"string",
"null"
]
},
"available_versions_for_upgrade": {
"_name_": "available_versions_for_upgrade",
"title": "available_versions_for_upgrade",
"description": "List of available versions for upgrade",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"version": {
"_name_": "version",
"title": "version",
"description": "Version of the app",
"_required_": false,
"type": "string"
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"description": "Human readable version of the app",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "version_info",
"title": "version_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"version",
"human_version"
]
}
]
}
},
"additionalProperties": false,
"_name_": "upgrade_summary",
"title": "upgrade_summary",
"default": {},
"_required_": false,
"_attrs_order_": [
"latest_version",
"latest_human_version",
"upgrade_version",
"upgrade_human_version",
"changelog",
"available_versions_for_upgrade"
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve upgrade summary for |
app.used_ports |
---|
Return Arguments:
{
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "used_port",
"title": "used_port",
"_required_": false
}
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns ports in use by applications. |
app.image.delete |
---|
Arguments:
{
"_name_": "image_id",
"title": "image_id",
"_required_": false,
"type": "string",
"description": "Delete docker image `image_id`."
}
{
"type": "object",
"properties": {
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"force"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
Delete docker image
|
app.image.dockerhub_rate_limit |
---|
Return Arguments:
{
"type": "object",
"properties": {
"total_pull_limit": {
"type": [
"integer",
"null"
],
"_name_": "total_pull_limit",
"title": "total_pull_limit",
"description": "Total pull limit for Docker Hub registry",
"_required_": false
},
"total_time_limit_in_secs": {
"type": [
"integer",
"null"
],
"_name_": "total_time_limit_in_secs",
"title": "total_time_limit_in_secs",
"description": "Total time limit in seconds for Docker Hub registry before the limit renews",
"_required_": false
},
"remaining_pull_limit": {
"type": [
"integer",
"null"
],
"_name_": "remaining_pull_limit",
"title": "remaining_pull_limit",
"description": "Remaining pull limit for Docker Hub registry",
"_required_": false
},
"remaining_time_limit_in_secs": {
"type": [
"integer",
"null"
],
"_name_": "remaining_time_limit_in_secs",
"title": "remaining_time_limit_in_secs",
"description": "Remaining time limit in seconds for Docker Hub registry for the current pull limit to be renewed",
"_required_": false
},
"error": {
"_name_": "error",
"title": "error",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "dockerhub_rate_limit",
"title": "dockerhub_rate_limit",
"default": {},
"_required_": false,
"_attrs_order_": [
"total_pull_limit",
"total_time_limit_in_secs",
"remaining_pull_limit",
"remaining_time_limit_in_secs",
"error"
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns the current rate limit information for Docker Hub registry. Please refer to https://docs.docker.com/docker-hub/download-rate-limit/ for more information. |
app.image.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"repo_tags": {
"_name_": "repo_tags",
"title": "repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_tag",
"title": "repo_tag",
"_required_": false,
"type": "string"
}
]
},
"repo_digests": {
"_name_": "repo_digests",
"title": "repo_digests",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_digest",
"title": "repo_digest",
"_required_": false,
"type": "string"
}
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
},
"dangling": {
"type": "boolean",
"_name_": "dangling",
"title": "dangling",
"_required_": false
},
"update_available": {
"type": "boolean",
"_name_": "update_available",
"title": "update_available",
"_required_": false
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"author": {
"_name_": "author",
"title": "author",
"_required_": false,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"parsed_repo_tags": {
"_name_": "parsed_repo_tags",
"title": "parsed_repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string"
},
"registry": {
"_name_": "registry",
"title": "registry",
"_required_": false,
"type": "string"
},
"complete_tag": {
"_name_": "complete_tag",
"title": "complete_tag",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "parsed_repo_tag",
"title": "parsed_repo_tag",
"default": {},
"_required_": false,
"_attrs_order_": [
"image",
"tag",
"registry",
"complete_tag"
]
}
]
}
},
"additionalProperties": true,
"_name_": "app_image_entry",
"title": "app_image_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"repo_tags",
"repo_digests",
"size",
"dangling",
"update_available",
"created",
"author",
"comment",
"parsed_repo_tags"
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
app.image.pull
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"auth_config": {
"type": "object",
"properties": {
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "auth_config",
"title": "auth_config",
"default": null,
"_required_": false,
"_attrs_order_": [
"username",
"password"
]
},
"image": {
"_name_": "image",
"title": "image",
"_required_": true,
"type": "string",
"description": "`image` is the name of the image to pull. Format for the name is \"registry/repo/image:v1.2.3\" where\nregistry may be omitted and it will default to docker registry in this case. It can or cannot contain\nthe tag - this will be passed as is to docker so this should be analogous to what `docker pull` expects."
}
},
"additionalProperties": false,
"_name_": "image_pull",
"title": "image_pull",
"default": {},
"_required_": false,
"_attrs_order_": [
"auth_config",
"image"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE |
|
app.image.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"repo_tags": {
"_name_": "repo_tags",
"title": "repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_tag",
"title": "repo_tag",
"_required_": false,
"type": "string"
}
]
},
"repo_digests": {
"_name_": "repo_digests",
"title": "repo_digests",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_digest",
"title": "repo_digest",
"_required_": false,
"type": "string"
}
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
},
"dangling": {
"type": "boolean",
"_name_": "dangling",
"title": "dangling",
"_required_": false
},
"update_available": {
"type": "boolean",
"_name_": "update_available",
"title": "update_available",
"_required_": false
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"author": {
"_name_": "author",
"title": "author",
"_required_": false,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"parsed_repo_tags": {
"_name_": "parsed_repo_tags",
"title": "parsed_repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string"
},
"registry": {
"_name_": "registry",
"title": "registry",
"_required_": false,
"type": "string"
},
"complete_tag": {
"_name_": "complete_tag",
"title": "complete_tag",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "parsed_repo_tag",
"title": "parsed_repo_tag",
"default": {},
"_required_": false,
"_attrs_order_": [
"image",
"tag",
"registry",
"complete_tag"
]
}
]
}
},
"additionalProperties": true,
"_name_": "app_image_entry",
"title": "app_image_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"repo_tags",
"repo_digests",
"size",
"dangling",
"update_available",
"created",
"author",
"comment",
"parsed_repo_tags"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"repo_tags": {
"_name_": "repo_tags",
"title": "repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_tag",
"title": "repo_tag",
"_required_": false,
"type": "string"
}
]
},
"repo_digests": {
"_name_": "repo_digests",
"title": "repo_digests",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_digest",
"title": "repo_digest",
"_required_": false,
"type": "string"
}
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
},
"dangling": {
"type": "boolean",
"_name_": "dangling",
"title": "dangling",
"_required_": false
},
"update_available": {
"type": "boolean",
"_name_": "update_available",
"title": "update_available",
"_required_": false
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"author": {
"_name_": "author",
"title": "author",
"_required_": false,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"parsed_repo_tags": {
"_name_": "parsed_repo_tags",
"title": "parsed_repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string"
},
"registry": {
"_name_": "registry",
"title": "registry",
"_required_": false,
"type": "string"
},
"complete_tag": {
"_name_": "complete_tag",
"title": "complete_tag",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "parsed_repo_tag",
"title": "parsed_repo_tag",
"default": {},
"_required_": false,
"_attrs_order_": [
"image",
"tag",
"registry",
"complete_tag"
]
}
]
}
},
"additionalProperties": true,
"_name_": "app_image_entry",
"title": "app_image_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"repo_tags",
"repo_digests",
"size",
"dangling",
"update_available",
"created",
"author",
"comment",
"parsed_repo_tags"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"repo_tags": {
"_name_": "repo_tags",
"title": "repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_tag",
"title": "repo_tag",
"_required_": false,
"type": "string"
}
]
},
"repo_digests": {
"_name_": "repo_digests",
"title": "repo_digests",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_digest",
"title": "repo_digest",
"_required_": false,
"type": "string"
}
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
},
"dangling": {
"type": "boolean",
"_name_": "dangling",
"title": "dangling",
"_required_": false
},
"update_available": {
"type": "boolean",
"_name_": "update_available",
"title": "update_available",
"_required_": false
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"author": {
"_name_": "author",
"title": "author",
"_required_": false,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"parsed_repo_tags": {
"_name_": "parsed_repo_tags",
"title": "parsed_repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string"
},
"registry": {
"_name_": "registry",
"title": "registry",
"_required_": false,
"type": "string"
},
"complete_tag": {
"_name_": "complete_tag",
"title": "complete_tag",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "parsed_repo_tag",
"title": "parsed_repo_tag",
"default": {},
"_required_": false,
"_attrs_order_": [
"image",
"tag",
"registry",
"complete_tag"
]
}
]
}
},
"additionalProperties": true,
"_name_": "app_image_entry",
"title": "app_image_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"repo_tags",
"repo_digests",
"size",
"dangling",
"update_available",
"created",
"author",
"comment",
"parsed_repo_tags"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query all docker images with
|
audit.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"retention": {
"type": "integer",
"_name_": "retention",
"title": "retention",
"_required_": false
},
"reservation": {
"type": "integer",
"_name_": "reservation",
"title": "reservation",
"_required_": false
},
"quota": {
"type": "integer",
"_name_": "quota",
"title": "quota",
"_required_": false
},
"quota_fill_warning": {
"type": "integer",
"_name_": "quota_fill_warning",
"title": "quota_fill_warning",
"_required_": false
},
"quota_fill_critical": {
"type": "integer",
"_name_": "quota_fill_critical",
"title": "quota_fill_critical",
"_required_": false
},
"available": {
"type": "integer",
"_name_": "available",
"title": "available",
"_required_": false
},
"space": {
"type": "object",
"properties": {
"used": {
"type": "integer",
"_name_": "used",
"title": "used",
"_required_": false
},
"used_by_snapshots": {
"type": "integer",
"_name_": "used_by_snapshots",
"title": "used_by_snapshots",
"_required_": false
},
"available": {
"type": "integer",
"_name_": "available",
"title": "available",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "space",
"title": "space",
"default": {},
"_required_": false,
"_attrs_order_": [
"used",
"used_by_snapshots",
"available"
]
},
"remote_logging_enabled": {
"type": "boolean",
"_name_": "remote_logging_enabled",
"title": "remote_logging_enabled",
"_required_": false
},
"enabled_services": {
"_name_": "enabled_services",
"title": "enabled_services",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "system_audit_config",
"title": "system_audit_config",
"default": {},
"_required_": false,
"_attrs_order_": [
"retention",
"reservation",
"quota",
"quota_fill_warning",
"quota_fill_critical",
"available",
"space",
"remote_logging_enabled",
"enabled_services"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_AUDIT_READ |
- |
audit.download_report |
---|
Arguments:
{
"type": "object",
"properties": {
"report_name": {
"_name_": "report_name",
"title": "report_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "audit_download",
"title": "audit_download",
"default": {},
"_required_": false,
"_attrs_order_": [
"report_name"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_AUDIT_READ |
Download the audit report with the specified name from the server. Note that users will only be able to download reports that they personally generated. |
audit.export
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"services": {
"_name_": "services",
"title": "services",
"default": [
"MIDDLEWARE",
"SUDO"
],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "db_name",
"title": "db_name",
"_required_": false,
"type": "string",
"enum": [
"MIDDLEWARE",
"SMB",
"SUDO"
]
}
],
"description": "`query-options` for the specified `services` in the specified `export_format`."
},
"query-filters": {
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
},
"query-options": {
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
},
"export_format": {
"_name_": "export_format",
"title": "export_format",
"default": "JSON",
"_required_": false,
"type": "string",
"enum": [
"CSV",
"JSON",
"YAML"
],
"description": "`query-options` for the specified `services` in the specified `export_format`."
}
},
"additionalProperties": false,
"_name_": "audit_export",
"title": "audit_export",
"default": {},
"_required_": false,
"_attrs_order_": [
"services",
"query-filters",
"query-options",
"export_format"
]
}
|
Return Arguments:
{
"_name_": "audit_file_path",
"title": "audit_file_path",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_AUDIT_READ |
Generate an audit report based on the specified Supported export_formats are CSV, JSON, and YAML. The endpoint returns a local filesystem path where the resulting audit report is located. |
audit.query |
---|
Arguments:
{
"type": "object",
"properties": {
"services": {
"_name_": "services",
"title": "services",
"default": [
"MIDDLEWARE",
"SUDO"
],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "db_name",
"title": "db_name",
"_required_": false,
"type": "string",
"enum": [
"MIDDLEWARE",
"SMB",
"SUDO"
]
}
],
"description": "Query contents of audit databases specified by `services`.\n`services` - Name of the service that generated the message. This will\nbe one of the names specified in `services`."
},
"query-filters": {
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
},
"query-options": {
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
},
"additionalProperties": false,
"_name_": "audit_query",
"title": "audit_query",
"default": {},
"_required_": false,
"_attrs_order_": [
"services",
"query-filters",
"query-options"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"audit_id": {
"_name_": "audit_id",
"title": "audit_id",
"_required_": false,
"type": "string"
},
"message_timestamp": {
"type": "integer",
"_name_": "message_timestamp",
"title": "message_timestamp",
"_required_": false
},
"timestamp": {
"_name_": "timestamp",
"title": "timestamp",
"_required_": false,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
},
"session": {
"_name_": "session",
"title": "session",
"_required_": false,
"type": "string"
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string",
"enum": [
"MIDDLEWARE",
"SMB",
"SUDO"
]
},
"service_data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "service_data",
"title": "service_data",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"event": {
"_name_": "event",
"title": "event",
"_required_": false,
"type": "string"
},
"event_data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "event_data",
"title": "event_data",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"success": {
"type": "boolean",
"_name_": "success",
"title": "success",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "audit_entry",
"title": "audit_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"audit_id",
"message_timestamp",
"timestamp",
"address",
"username",
"session",
"service",
"service_data",
"event",
"event_data",
"success"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"audit_id": {
"_name_": "audit_id",
"title": "audit_id",
"_required_": false,
"type": "string"
},
"message_timestamp": {
"type": "integer",
"_name_": "message_timestamp",
"title": "message_timestamp",
"_required_": false
},
"timestamp": {
"_name_": "timestamp",
"title": "timestamp",
"_required_": false,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
},
"session": {
"_name_": "session",
"title": "session",
"_required_": false,
"type": "string"
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string",
"enum": [
"MIDDLEWARE",
"SMB",
"SUDO"
]
},
"service_data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "service_data",
"title": "service_data",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"event": {
"_name_": "event",
"title": "event",
"_required_": false,
"type": "string"
},
"event_data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "event_data",
"title": "event_data",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"success": {
"type": "boolean",
"_name_": "success",
"title": "success",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "audit_entry",
"title": "audit_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"audit_id",
"message_timestamp",
"timestamp",
"address",
"username",
"session",
"service",
"service_data",
"event",
"event_data",
"success"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_AUDIT_READ |
Query contents of audit databases specified by If the query-option Each audit entry contains the following keys:
|
audit.update |
---|
Arguments:
{
"type": "object",
"properties": {
"retention": {
"type": "integer",
"_name_": "retention",
"title": "retention",
"_required_": false,
"description": "`retention` - number of days to retain local audit messages."
},
"reservation": {
"type": "integer",
"_name_": "reservation",
"title": "reservation",
"_required_": false,
"description": "`reservation` - size in GiB of refreservation to set on ZFS dataset\nwhere the audit databases are stored. The refreservation specifies the\nminimum amount of space guaranteed to the dataset, and counts against\nthe space available for other datasets in the zpool where the audit\ndataset is located."
},
"quota": {
"type": "integer",
"_name_": "quota",
"title": "quota",
"_required_": false,
"description": "`quota` - size in GiB of the maximum amount of space that may be\nconsumed by the dataset where the audit dabases are stored."
},
"quota_fill_warning": {
"type": "integer",
"_name_": "quota_fill_warning",
"title": "quota_fill_warning",
"_required_": false,
"description": "`quota_fill_warning` - percentage used of dataset quota at which to\ngenerate a warning alert."
},
"quota_fill_critical": {
"type": "integer",
"_name_": "quota_fill_critical",
"title": "quota_fill_critical",
"_required_": false,
"description": "`quota_fill_critical` - percentage used of dataset quota at which to\ngenerate a critical alert."
}
},
"additionalProperties": false,
"_name_": "system_audit_update",
"title": "system_audit_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"retention",
"reservation",
"quota",
"quota_fill_warning",
"quota_fill_critical"
]
}
|
This method is accessible to the users granted with the following roles: SYSTEM_AUDIT_WRITE |
Update default audit settings. The following fields may be modified:
The following fields contain read-only data and are returned in calls
to
|
auth.check_password |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
{
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "check_password",
"title": "check_password",
"description": "Is `true` if `username` was successfully validated with provided `password`",
"_required_": false
}
|
Verify username and password |
auth.check_user |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
{
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "check_user",
"title": "check_user",
"description": "Is `true` if `username` was successfully validated with provided `password`",
"_required_": false
}
|
Verify username and password |
auth.generate_token |
---|
Arguments:
{
"type": [
"integer",
"null"
],
"_name_": "ttl",
"title": "ttl",
"default": 600,
"_required_": false,
"description": "`ttl` stands for Time To Live, in seconds. The token will be invalidated if the connection\nhas been inactive for a time greater than this."
}
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attrs",
"title": "attrs",
"default": {},
"_required_": false,
"_attrs_order_": [],
"description": "`attrs` is a general purpose object/dictionary to hold information about the token."
}
{
"type": "boolean",
"_name_": "match_origin",
"title": "match_origin",
"default": false,
"_required_": false
}
|
Return Arguments:
{
"_name_": "token",
"title": "token",
"_required_": false,
"type": "string"
}
|
Generate a token to be used for authentication.
|
auth.login |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
{
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
}
{
"_name_": "otp_token",
"title": "otp_token",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successful_login",
"title": "successful_login",
"_required_": false
}
|
Authenticate session using username and password.
|
auth.login_with_api_key |
---|
Arguments:
{
"_name_": "api_key",
"title": "api_key",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successful_login",
"title": "successful_login",
"_required_": false
}
|
Authenticate session using API Key. |
auth.login_with_token |
---|
Arguments:
{
"_name_": "token",
"title": "token",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successful_login",
"title": "successful_login",
"_required_": false
}
|
Authenticate session using token generated with |
auth.logout |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "successful_logout",
"title": "successful_logout",
"_required_": false
}
|
Deauthenticates an app and if a token exists, removes that from the session. |
auth.me |
---|
Return Arguments:
{
"type": "object",
"properties": {
"pw_name": {
"_name_": "pw_name",
"title": "pw_name",
"_required_": false,
"type": "string"
},
"pw_gecos": {
"_name_": "pw_gecos",
"title": "pw_gecos",
"_required_": false,
"type": "string"
},
"pw_dir": {
"_name_": "pw_dir",
"title": "pw_dir",
"_required_": false,
"type": "string"
},
"pw_shell": {
"_name_": "pw_shell",
"title": "pw_shell",
"_required_": false,
"type": "string"
},
"pw_uid": {
"type": "integer",
"_name_": "pw_uid",
"title": "pw_uid",
"_required_": false
},
"pw_gid": {
"type": "integer",
"_name_": "pw_gid",
"title": "pw_gid",
"_required_": false
},
"grouplist": {
"_name_": "grouplist",
"title": "grouplist",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"ACTIVEDIRECTORY",
"LDAP"
]
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"two_factor_config": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "two_factor_config",
"title": "two_factor_config",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "current_user_information",
"title": "current_user_information",
"default": {},
"_required_": false,
"_attrs_order_": [
"pw_name",
"pw_gecos",
"pw_dir",
"pw_shell",
"pw_uid",
"pw_gid",
"grouplist",
"sid",
"source",
"local",
"attributes",
"two_factor_config"
]
}
|
Returns currently logged-in user. |
auth.sessions |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"current": {
"type": "boolean",
"_name_": "current",
"title": "current",
"_required_": false
},
"internal": {
"type": "boolean",
"_name_": "internal",
"title": "internal",
"_required_": false
},
"origin": {
"_name_": "origin",
"title": "origin",
"_required_": false,
"type": "string"
},
"credentials": {
"_name_": "credentials",
"title": "credentials",
"_required_": false,
"type": "string"
},
"credentials_data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials_data",
"title": "credentials_data",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"created_at": {
"_name_": "created_at",
"title": "created_at",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "session",
"title": "session",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"current",
"internal",
"origin",
"credentials",
"credentials_data",
"created_at"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"current": {
"type": "boolean",
"_name_": "current",
"title": "current",
"_required_": false
},
"internal": {
"type": "boolean",
"_name_": "internal",
"title": "internal",
"_required_": false
},
"origin": {
"_name_": "origin",
"title": "origin",
"_required_": false,
"type": "string"
},
"credentials": {
"_name_": "credentials",
"title": "credentials",
"_required_": false,
"type": "string"
},
"credentials_data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials_data",
"title": "credentials_data",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"created_at": {
"_name_": "created_at",
"title": "created_at",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "session",
"title": "session",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"current",
"internal",
"origin",
"credentials",
"credentials_data",
"created_at"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: AUTH_SESSIONS_READ, AUTH_SESSIONS_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns list of active auth sessions. Example of return value: [ { "id": "NyhB1J5vjPjIV82yZ6caU12HLA1boDJcZNWuVQM4hQWuiyUWMGZTz2ElDp7Yk87d", "origin": "192.168.0.3:40392", "credentials": "LOGIN_PASSWORD", "credentials_data": {"username": "root"}, "current": True, "internal": False, "created_at": {"$date": 1545842426070} } ]
If you want to exclude all internal connections from the list, call this method with following arguments: [ [ ["internal", "=", True] ] ] |
auth.set_attribute |
---|
Arguments:
{
"_name_": "key",
"title": "key",
"_required_": false,
"type": "string",
"description": "Set current user's `attributes` dictionary `key` to `value`."
}
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "value",
"title": "value",
"_required_": false,
"description": "Set current user's `attributes` dictionary `key` to `value`."
}
|
Set current user's e.g. Setting key="foo" value="var" will result in {"attributes": {"foo": "bar"}} |
auth.terminate_other_sessions |
---|
This method is accessible to the users granted with the following roles: AUTH_SESSIONS_WRITE |
Terminates all other sessions (except the current one). |
auth.terminate_session |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "terminate_session",
"title": "terminate_session",
"description": "Is `true` if session was terminated successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: AUTH_SESSIONS_WRITE |
Terminates session |
auth.two_factor_auth |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
{
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "two_factor_auth_enabled",
"title": "two_factor_auth_enabled",
"description": "Is `true` if 2FA is enabled",
"_required_": false
}
|
Returns true if two-factor authorization is required for authorizing user's login. |
auth.twofactor.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"services": {
"type": "object",
"properties": {
"ssh": {
"type": "boolean",
"_name_": "ssh",
"title": "ssh",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "services",
"title": "services",
"default": {},
"_required_": true,
"_attrs_order_": [
"ssh"
]
},
"window": {
"type": "integer",
"_name_": "window",
"title": "window",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "auth_twofactor_entry",
"title": "auth_twofactor_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"services",
"window",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
auth.twofactor.update |
---|
Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"services": {
"type": "object",
"properties": {
"ssh": {
"type": "boolean",
"_name_": "ssh",
"title": "ssh",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "services",
"title": "services",
"default": {},
"_required_": true,
"_attrs_order_": [
"ssh"
]
},
"window": {
"type": "integer",
"_name_": "window",
"title": "window",
"_required_": true,
"description": "`window` extends the validity to `window` many counter ticks before and after the current one."
}
},
"additionalProperties": false,
"_name_": "auth_twofactor_update",
"title": "auth_twofactor_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"services",
"window"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"services": {
"type": "object",
"properties": {
"ssh": {
"type": "boolean",
"_name_": "ssh",
"title": "ssh",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "services",
"title": "services",
"default": {},
"_required_": true,
"_attrs_order_": [
"ssh"
]
},
"window": {
"type": "integer",
"_name_": "window",
"title": "window",
"_required_": true,
"description": "`window` extends the validity to `window` many counter ticks before and after the current one."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "auth_twofactor_update_returns",
"title": "auth_twofactor_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"services",
"window",
"id"
]
}
|
Update Two-Factor Authentication Service Configuration. |
boot.attach
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "dev",
"title": "dev",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"expand": {
"type": "boolean",
"_name_": "expand",
"title": "expand",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"expand"
]
}
|
Attach a disk to the boot pool, turning a stripe into a mirror.
|
boot.detach |
---|
Arguments:
{
"_name_": "dev",
"title": "dev",
"_required_": false,
"type": "string"
}
|
Detach given |
boot.get_disks |
---|
Return Arguments:
{
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns disks of the boot pool. |
boot.get_scrub_interval |
---|
Return Arguments:
{
"type": "integer",
"_name_": "interval",
"title": "interval",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Get Automatic Scrub Interval value in days. |
boot.get_state |
---|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
]
}
},
"additionalProperties": false,
"_name_": "get_state",
"title": "get_state",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns the current state of the boot pool, including all vdevs, properties and datasets. |
boot.replace
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "label",
"title": "label",
"_required_": false,
"type": "string"
}
{
"_name_": "dev",
"title": "dev",
"_required_": false,
"type": "string"
}
|
Replace device |
boot.scrub
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Scrub on boot pool. |
boot.set_scrub_interval |
---|
Arguments:
{
"type": "integer",
"_name_": "interval",
"title": "interval",
"_required_": false
}
|
Return Arguments:
{
"type": "integer",
"_name_": "interval",
"title": "interval",
"_required_": false
}
|
Set Automatic Scrub Interval value in days. |
bootenv.activate |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successfully_activated",
"title": "successfully_activated",
"_required_": false
}
|
Activates boot environment |
bootenv.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Create a new boot environment using `name`.\nIf a new boot environment is desired which is a clone of another boot environment, `source` can be passed.\nThen, a new boot environment of `name` is created using boot environment `source` by cloning it."
},
"source": {
"_name_": "source",
"title": "source",
"_required_": true,
"type": "string",
"description": "If a new boot environment is desired which is a clone of another boot environment, `source` can be passed.\nThen, a new boot environment of `name` is created using boot environment `source` by cloning it."
}
},
"additionalProperties": false,
"_name_": "bootenv_create",
"title": "bootenv_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"source"
]
}
|
Return Arguments:
{
"_name_": "bootenv_name",
"title": "bootenv_name",
"_required_": false,
"type": "string"
}
|
Create a new boot environment using If a new boot environment is desired which is a clone of another boot environment, Ensure that |
bootenv.delete
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete |
bootenv.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"realname": {
"_name_": "realname",
"title": "realname",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"active": {
"_name_": "active",
"title": "active",
"_required_": false,
"type": "string"
},
"activated": {
"type": "boolean",
"_name_": "activated",
"title": "activated",
"_required_": false
},
"can_activate": {
"type": "boolean",
"_name_": "can_activate",
"title": "can_activate",
"_required_": false
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": "string"
},
"space": {
"_name_": "space",
"title": "space",
"_required_": false,
"type": "string"
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"keep": {
"type": "boolean",
"_name_": "keep",
"title": "keep",
"_required_": false
},
"rawspace": {
"type": "integer",
"_name_": "rawspace",
"title": "rawspace",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "bootenv_entry",
"title": "bootenv_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"realname",
"name",
"active",
"activated",
"can_activate",
"mountpoint",
"space",
"created",
"keep",
"rawspace"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
bootenv.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"realname": {
"_name_": "realname",
"title": "realname",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"active": {
"_name_": "active",
"title": "active",
"_required_": false,
"type": "string"
},
"activated": {
"type": "boolean",
"_name_": "activated",
"title": "activated",
"_required_": false
},
"can_activate": {
"type": "boolean",
"_name_": "can_activate",
"title": "can_activate",
"_required_": false
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": "string"
},
"space": {
"_name_": "space",
"title": "space",
"_required_": false,
"type": "string"
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"keep": {
"type": "boolean",
"_name_": "keep",
"title": "keep",
"_required_": false
},
"rawspace": {
"type": "integer",
"_name_": "rawspace",
"title": "rawspace",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "bootenv_entry",
"title": "bootenv_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"realname",
"name",
"active",
"activated",
"can_activate",
"mountpoint",
"space",
"created",
"keep",
"rawspace"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"realname": {
"_name_": "realname",
"title": "realname",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"active": {
"_name_": "active",
"title": "active",
"_required_": false,
"type": "string"
},
"activated": {
"type": "boolean",
"_name_": "activated",
"title": "activated",
"_required_": false
},
"can_activate": {
"type": "boolean",
"_name_": "can_activate",
"title": "can_activate",
"_required_": false
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": "string"
},
"space": {
"_name_": "space",
"title": "space",
"_required_": false,
"type": "string"
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"keep": {
"type": "boolean",
"_name_": "keep",
"title": "keep",
"_required_": false
},
"rawspace": {
"type": "integer",
"_name_": "rawspace",
"title": "rawspace",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "bootenv_entry",
"title": "bootenv_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"realname",
"name",
"active",
"activated",
"can_activate",
"mountpoint",
"space",
"created",
"keep",
"rawspace"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"realname": {
"_name_": "realname",
"title": "realname",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"active": {
"_name_": "active",
"title": "active",
"_required_": false,
"type": "string"
},
"activated": {
"type": "boolean",
"_name_": "activated",
"title": "activated",
"_required_": false
},
"can_activate": {
"type": "boolean",
"_name_": "can_activate",
"title": "can_activate",
"_required_": false
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": "string"
},
"space": {
"_name_": "space",
"title": "space",
"_required_": false,
"type": "string"
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"keep": {
"type": "boolean",
"_name_": "keep",
"title": "keep",
"_required_": false
},
"rawspace": {
"type": "integer",
"_name_": "rawspace",
"title": "rawspace",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "bootenv_entry",
"title": "bootenv_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"realname",
"name",
"active",
"activated",
"can_activate",
"mountpoint",
"space",
"created",
"keep",
"rawspace"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Query all Boot Environments with |
bootenv.set_attribute |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Sets attributes boot environment `id`."
}
{
"type": "object",
"properties": {
"keep": {
"type": "boolean",
"_name_": "keep",
"title": "keep",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"keep"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successfully_set_attribute",
"title": "successfully_set_attribute",
"_required_": false
}
|
Sets attributes boot environment Currently only |
bootenv.update |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Update `id` boot environment name with a new provided valid `name`.\nCreate a new boot environment using `name`."
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Update `id` boot environment name with a new provided valid `name`.\nCreate a new boot environment using `name`.\nThen, a new boot environment of `name` is created using boot environment `source` by cloning it."
}
},
"additionalProperties": false,
"_name_": "bootenv_update",
"title": "bootenv_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name"
]
}
|
Return Arguments:
{
"_name_": "bootenv_name",
"title": "bootenv_name",
"_required_": false,
"type": "string"
}
|
Update |
catalog.apps |
---|
Arguments:
{
"type": "object",
"properties": {
"cache": {
"type": "boolean",
"_name_": "cache",
"title": "cache",
"default": true,
"_required_": false
},
"cache_only": {
"type": "boolean",
"_name_": "cache_only",
"title": "cache_only",
"default": false,
"_required_": false
},
"retrieve_all_trains": {
"type": "boolean",
"_name_": "retrieve_all_trains",
"title": "retrieve_all_trains",
"default": true,
"_required_": false
},
"trains": {
"_name_": "trains",
"title": "trains",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "train_name",
"title": "train_name",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"cache",
"cache_only",
"retrieve_all_trains",
"trains"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "trains",
"title": "trains",
"description": "\n\nExample(s):\n```\n{\n \"stable\": {\n \"plex\": {\n \"app_readme\": \"
Plex\",\n \"categories\": [\n \"media\"\n ],\n \"description\": \"Plex is a media server that allows you to stream your media to any Plex client.\",\n \"healthy\": true,\n \"healthy_error\": null,\n \"home\": \"https://plex.tv\",\n \"location\": \"/mnt/.ix-apps/truenas_catalog/stable/plex\",\n \"latest_version\": \"1.0.0\",\n \"latest_app_version\": \"1.40.2.8395\",\n \"latest_human_version\": \"1.40.2.8395_1.0.0\",\n \"last_update\": \"2024-07-30 13:40:47+00:00\",\n \"name\": \"plex\",\n \"recommended\": false,\n \"title\": \"Plex\",\n \"maintainers\": [\n {\n \"email\": \"dev@ixsystems.com\",\n \"name\": \"truenas\",\n \"url\": \"https://www.truenas.com/\"\n }\n ],\n \"tags\": [\n \"plex\",\n \"media\",\n \"entertainment\",\n \"movies\",\n \"series\",\n \"tv\",\n \"streaming\"\n ],\n \"screenshots\": [\n \"https://media.sys.truenas.net/apps/plex/screenshots/screenshot2.png\"\n ],\n \"sources\": [\n \"https://plex.tv\",\n \"https://hub.docker.com/r/plexinc/pms-docker\"\n ],\n \"icon_url\": \"https://media.sys.truenas.net/apps/plex/icons/icon.png\"\n }\n }\n}\n```\n", "default": {}, "_required_": false, "_attrs_order_": [] } |
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve apps details for
|
catalog.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"preferred_trains": {
"_name_": "preferred_trains",
"title": "preferred_trains",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"label": {
"_name_": "label",
"title": "label",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "catalog_create",
"title": "catalog_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"preferred_trains",
"id",
"label"
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
catalog.get_app_details |
---|
Arguments:
{
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"train": {
"_name_": "train",
"title": "train",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "app_version_details",
"title": "app_version_details",
"default": {},
"_required_": false,
"_attrs_order_": [
"train"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"categories": {
"_name_": "categories",
"title": "categories",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "category",
"title": "category",
"_required_": false,
"type": "string"
}
]
},
"maintainers": {
"_name_": "maintainers",
"title": "maintainers",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"tags": {
"_name_": "tags",
"title": "tags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"screenshots": {
"_name_": "screenshots",
"title": "screenshots",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "screenshot",
"title": "screenshot",
"_required_": false,
"type": "string"
}
]
},
"sources": {
"_name_": "sources",
"title": "sources",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
}
]
},
"app_readme": {
"_name_": "app_readme",
"title": "app_readme",
"_required_": true,
"type": [
"string",
"null"
]
},
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"recommended": {
"type": "boolean",
"_name_": "recommended",
"title": "recommended",
"_required_": true
},
"healthy_error": {
"_name_": "healthy_error",
"title": "healthy_error",
"_required_": true,
"type": [
"string",
"null"
]
},
"versions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "versions",
"title": "versions",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"latest_version": {
"_name_": "latest_version",
"title": "latest_version",
"_required_": true,
"type": [
"string",
"null"
]
},
"latest_app_version": {
"_name_": "latest_app_version",
"title": "latest_app_version",
"_required_": true,
"type": [
"string",
"null"
]
},
"latest_human_version": {
"_name_": "latest_human_version",
"title": "latest_human_version",
"_required_": true,
"type": [
"string",
"null"
]
},
"last_update": {
"_name_": "last_update",
"title": "last_update",
"_required_": true,
"type": [
"string",
"null"
]
},
"icon_url": {
"_name_": "icon_url",
"title": "icon_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"home": {
"_name_": "home",
"title": "home",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "app_details",
"title": "app_details",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"categories",
"maintainers",
"tags",
"screenshots",
"sources",
"app_readme",
"location",
"healthy",
"recommended",
"healthy_error",
"versions",
"latest_version",
"latest_app_version",
"latest_human_version",
"last_update",
"icon_url",
"home"
]
}
|
This method is accessible to the users granted with the following roles: APPS_READ, APPS_WRITE, CATALOG_READ, CATALOG_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve information of |
catalog.sync
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
This method is accessible to the users granted with the following roles: APPS_WRITE, CATALOG_WRITE |
Sync truenas catalog to retrieve latest changes from upstream. |
catalog.trains |
---|
Return Arguments:
{
"_name_": "trains",
"title": "trains",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "train",
"title": "train",
"_required_": false,
"type": "string"
}
]
}
|
Retrieve available trains. |
catalog.update |
---|
Arguments:
{
"type": "object",
"properties": {
"preferred_trains": {
"_name_": "preferred_trains",
"title": "preferred_trains",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "catalog_update",
"title": "catalog_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"preferred_trains"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"preferred_trains": {
"_name_": "preferred_trains",
"title": "preferred_trains",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"label": {
"_name_": "label",
"title": "label",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "catalog_update_returns",
"title": "catalog_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"preferred_trains",
"id",
"label"
]
}
|
This method is accessible to the users granted with the following roles: APPS_WRITE, CATALOG_WRITE |
Update catalog preferences. |
certificate.acme_server_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme_server_choices",
"title": "acme_server_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Dictionary of popular ACME Servers with their directory URI endpoints which we display automatically in UI |
certificate.certificate_signing_requests_profiles |
---|
Return Arguments:
{
"type": "object",
"properties": {
"HTTPS RSA Certificate": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "HTTPS RSA Certificate",
"title": "HTTPS RSA Certificate",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"HTTPS ECC Certificate": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "HTTPS ECC Certificate",
"title": "HTTPS ECC Certificate",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "certificate_signing_requests_profiles",
"title": "certificate_signing_requests_profiles",
"description": "\n\nExample(s):\n```\n{\n \"HTTPS RSA Certificate\": {\n \"cert_extensions\": {\n \"BasicConstraints\": {\n \"enabled\": true,\n \"ca\": false,\n \"extension_critical\": true\n },\n \"ExtendedKeyUsage\": {\n \"enabled\": true,\n \"extension_critical\": true,\n \"usages\": [\n \"SERVER_AUTH\",\n \"CLIENT_AUTH\"\n ]\n },\n \"KeyUsage\": {\n \"enabled\": true,\n \"extension_critical\": true,\n \"digital_signature\": true,\n \"key_encipherment\": true,\n \"key_agreement\": true\n }\n },\n \"key_length\": 2048,\n \"key_type\": \"RSA\",\n \"lifetime\": 397,\n \"digest_algorithm\": \"SHA256\"\n },\n \"HTTPS ECC Certificate\": {\n \"cert_extensions\": {\n \"BasicConstraints\": {\n \"enabled\": true,\n \"ca\": false,\n \"extension_critical\": true\n },\n \"ExtendedKeyUsage\": {\n \"enabled\": true,\n \"extension_critical\": true,\n \"usages\": [\n \"SERVER_AUTH\",\n \"CLIENT_AUTH\"\n ]\n },\n \"KeyUsage\": {\n \"enabled\": true,\n \"extension_critical\": true,\n \"digital_signature\": true\n }\n },\n \"ec_curve\": \"SECP384R1\",\n \"key_type\": \"EC\",\n \"lifetime\": 397,\n \"digest_algorithm\": \"SHA256\"\n }\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": [
"HTTPS RSA Certificate",
"HTTPS ECC Certificate"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns a dictionary of predefined options for specific use cases i.e openvpn client/server configurations which can be used for creating certificate signing requests. |
certificate.country_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "country_choices",
"title": "country_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns country choices for creating a certificate/csr. |
certificate.create
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"tos": {
"type": "boolean",
"_name_": "tos",
"title": "tos",
"_required_": false
},
"dns_mapping": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "dns_mapping",
"title": "dns_mapping",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"csr_id": {
"type": "integer",
"_name_": "csr_id",
"title": "csr_id",
"_required_": false
},
"signedby": {
"type": "integer",
"_name_": "signedby",
"title": "signedby",
"_required_": false
},
"key_length": {
"type": "integer",
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"lifetime": {
"type": "integer",
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": "integer",
"_name_": "serial",
"title": "serial",
"_required_": false
},
"acme_directory_uri": {
"_name_": "acme_directory_uri",
"title": "acme_directory_uri",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": "string"
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": "string"
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": "string"
},
"ec_curve": {
"_name_": "ec_curve",
"title": "ec_curve",
"default": "SECP384R1",
"_required_": false,
"type": "string",
"enum": [
"SECP256R1",
"SECP384R1",
"SECP521R1",
"ed25519"
],
"description": "`key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic Curve Key, then default to\nusing \"SECP384R1\" curve."
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": "string"
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"default": "RSA",
"_required_": false,
"type": "string",
"enum": [
"RSA",
"EC"
],
"description": "`key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic Curve Key, then default to\nusing \"SECP384R1\" curve."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": "string"
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": "string"
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"_required_": false,
"type": "string"
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"create_type": {
"_name_": "create_type",
"title": "create_type",
"_required_": true,
"type": "string",
"enum": [
"CERTIFICATE_CREATE_INTERNAL",
"CERTIFICATE_CREATE_IMPORTED",
"CERTIFICATE_CREATE_CSR",
"CERTIFICATE_CREATE_IMPORTED_CSR",
"CERTIFICATE_CREATE_ACME"
],
"description": "Certificates are classified under following types and the necessary keywords to be passed\nfor `create_type` attribute to create the respective type of certificate\nA type is selected by the Certificate Service based on `create_type`. The rest of the values in `data` are\nvalidated accordingly and finally a certificate is made based on the selected type."
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": "string",
"enum": [
"SHA224",
"SHA256",
"SHA384",
"SHA512"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "san",
"title": "san",
"_required_": false,
"type": "string"
}
]
},
"cert_extensions": {
"type": "object",
"properties": {
"BasicConstraints": {
"type": "object",
"properties": {
"ca": {
"type": "boolean",
"_name_": "ca",
"title": "ca",
"default": false,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"path_length": {
"type": [
"integer",
"null"
],
"_name_": "path_length",
"title": "path_length",
"default": null,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "BasicConstraints",
"title": "BasicConstraints",
"default": {},
"_required_": false,
"_attrs_order_": [
"ca",
"enabled",
"path_length",
"extension_critical"
]
},
"AuthorityKeyIdentifier": {
"type": "object",
"properties": {
"authority_cert_issuer": {
"type": "boolean",
"_name_": "authority_cert_issuer",
"title": "authority_cert_issuer",
"default": false,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "AuthorityKeyIdentifier",
"title": "AuthorityKeyIdentifier",
"default": {},
"_required_": false,
"_attrs_order_": [
"authority_cert_issuer",
"enabled",
"extension_critical"
]
},
"ExtendedKeyUsage": {
"type": "object",
"properties": {
"usages": {
"_name_": "usages",
"title": "usages",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "usage",
"title": "usage",
"_required_": false,
"type": "string",
"enum": [
"ANY_EXTENDED_KEY_USAGE",
"CERTIFICATE_TRANSPARENCY",
"CLIENT_AUTH",
"CODE_SIGNING",
"EMAIL_PROTECTION",
"IPSEC_IKE",
"KERBEROS_PKINIT_KDC",
"OCSP_SIGNING",
"SERVER_AUTH",
"SMARTCARD_LOGON",
"TIME_STAMPING"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ExtendedKeyUsage",
"title": "ExtendedKeyUsage",
"default": {},
"_required_": false,
"_attrs_order_": [
"usages",
"enabled",
"extension_critical"
]
},
"KeyUsage": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"digital_signature": {
"type": "boolean",
"_name_": "digital_signature",
"title": "digital_signature",
"default": false,
"_required_": false
},
"content_commitment": {
"type": "boolean",
"_name_": "content_commitment",
"title": "content_commitment",
"default": false,
"_required_": false
},
"key_encipherment": {
"type": "boolean",
"_name_": "key_encipherment",
"title": "key_encipherment",
"default": false,
"_required_": false
},
"data_encipherment": {
"type": "boolean",
"_name_": "data_encipherment",
"title": "data_encipherment",
"default": false,
"_required_": false
},
"key_agreement": {
"type": "boolean",
"_name_": "key_agreement",
"title": "key_agreement",
"default": false,
"_required_": false
},
"key_cert_sign": {
"type": "boolean",
"_name_": "key_cert_sign",
"title": "key_cert_sign",
"default": false,
"_required_": false
},
"crl_sign": {
"type": "boolean",
"_name_": "crl_sign",
"title": "crl_sign",
"default": false,
"_required_": false
},
"encipher_only": {
"type": "boolean",
"_name_": "encipher_only",
"title": "encipher_only",
"default": false,
"_required_": false
},
"decipher_only": {
"type": "boolean",
"_name_": "decipher_only",
"title": "decipher_only",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "KeyUsage",
"title": "KeyUsage",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"digital_signature",
"content_commitment",
"key_encipherment",
"data_encipherment",
"key_agreement",
"key_cert_sign",
"crl_sign",
"encipher_only",
"decipher_only",
"extension_critical"
]
}
},
"additionalProperties": false,
"_name_": "cert_extensions",
"title": "cert_extensions",
"default": {},
"_required_": false,
"_attrs_order_": [
"BasicConstraints",
"AuthorityKeyIdentifier",
"ExtendedKeyUsage",
"KeyUsage"
],
"description": "`cert_extensions` can be specified to set X509v3 extensions."
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_create",
"title": "certificate_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"tos",
"dns_mapping",
"csr_id",
"signedby",
"key_length",
"renew_days",
"type",
"lifetime",
"serial",
"acme_directory_uri",
"certificate",
"city",
"common",
"country",
"CSR",
"ec_curve",
"email",
"key_type",
"name",
"organization",
"organizational_unit",
"passphrase",
"privatekey",
"state",
"create_type",
"digest_algorithm",
"san",
"cert_extensions",
"add_to_trusted_store"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic Curve Key, then default to\nusing \"SECP384R1\" curve."
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_create_returns",
"title": "certificate_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_WRITE |
Create a new Certificate Certificates are classified under following types and the necessary keywords to be passed
for 1) Internal Certificate - CERTIFICATE_CREATE_INTERNAL 2) Imported Certificate - CERTIFICATE_CREATE_IMPORTED 3) Certificate Signing Request - CERTIFICATE_CREATE_CSR 4) Imported Certificate Signing Request - CERTIFICATE_CREATE_IMPORTED_CSR 5) ACME Certificate - CERTIFICATE_CREATE_ACME By default, created certs use RSA keys. If an Elliptic Curve Key is desired, it can be specified with the
A type is selected by the Certificate Service based on
|
Create an ACME based certificate
Create an Imported Certificate Signing Request
Create an Internal Certificate
|
certificate.delete
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete certificate of `id`."
}
{
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false,
"description": "If the certificate is an ACME based certificate, certificate service will try to\nrevoke the certificate by updating it's status with the ACME server, if it fails an exception is raised\nand the certificate is not deleted from the system. However, if `force` is set to True, certificate is deleted\nfrom the system even if some error occurred while revoking the certificate with the ACME Server"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_WRITE |
Delete certificate of If the certificate is an ACME based certificate, certificate service will try to
revoke the certificate by updating it's status with the ACME server, if it fails an exception is raised
and the certificate is not deleted from the system. However, if |
Delete certificate of
|
certificate.ec_curve_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"SECP256R1": {
"_name_": "SECP256R1",
"title": "SECP256R1",
"_required_": false,
"type": "string",
"enum": [
"SECP256R1"
]
},
"SECP384R1": {
"_name_": "SECP384R1",
"title": "SECP384R1",
"_required_": false,
"type": "string",
"enum": [
"SECP384R1"
]
},
"SECP521R1": {
"_name_": "SECP521R1",
"title": "SECP521R1",
"_required_": false,
"type": "string",
"enum": [
"SECP521R1"
]
},
"ed25519": {
"_name_": "ed25519",
"title": "ed25519",
"_required_": false,
"type": "string",
"enum": [
"ed25519"
]
}
},
"additionalProperties": false,
"_name_": "ec_curve_choices",
"title": "ec_curve_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"SECP256R1",
"SECP384R1",
"SECP521R1",
"ed25519"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Dictionary of supported EC curves. |
certificate.extended_key_usage_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"ANY_EXTENDED_KEY_USAGE": {
"_name_": "ANY_EXTENDED_KEY_USAGE",
"title": "ANY_EXTENDED_KEY_USAGE",
"_required_": false,
"type": "string",
"enum": [
"ANY_EXTENDED_KEY_USAGE"
]
},
"CERTIFICATE_TRANSPARENCY": {
"_name_": "CERTIFICATE_TRANSPARENCY",
"title": "CERTIFICATE_TRANSPARENCY",
"_required_": false,
"type": "string",
"enum": [
"CERTIFICATE_TRANSPARENCY"
]
},
"CLIENT_AUTH": {
"_name_": "CLIENT_AUTH",
"title": "CLIENT_AUTH",
"_required_": false,
"type": "string",
"enum": [
"CLIENT_AUTH"
]
},
"CODE_SIGNING": {
"_name_": "CODE_SIGNING",
"title": "CODE_SIGNING",
"_required_": false,
"type": "string",
"enum": [
"CODE_SIGNING"
]
},
"EMAIL_PROTECTION": {
"_name_": "EMAIL_PROTECTION",
"title": "EMAIL_PROTECTION",
"_required_": false,
"type": "string",
"enum": [
"EMAIL_PROTECTION"
]
},
"IPSEC_IKE": {
"_name_": "IPSEC_IKE",
"title": "IPSEC_IKE",
"_required_": false,
"type": "string",
"enum": [
"IPSEC_IKE"
]
},
"KERBEROS_PKINIT_KDC": {
"_name_": "KERBEROS_PKINIT_KDC",
"title": "KERBEROS_PKINIT_KDC",
"_required_": false,
"type": "string",
"enum": [
"KERBEROS_PKINIT_KDC"
]
},
"OCSP_SIGNING": {
"_name_": "OCSP_SIGNING",
"title": "OCSP_SIGNING",
"_required_": false,
"type": "string",
"enum": [
"OCSP_SIGNING"
]
},
"SERVER_AUTH": {
"_name_": "SERVER_AUTH",
"title": "SERVER_AUTH",
"_required_": false,
"type": "string",
"enum": [
"SERVER_AUTH"
]
},
"SMARTCARD_LOGON": {
"_name_": "SMARTCARD_LOGON",
"title": "SMARTCARD_LOGON",
"_required_": false,
"type": "string",
"enum": [
"SMARTCARD_LOGON"
]
},
"TIME_STAMPING": {
"_name_": "TIME_STAMPING",
"title": "TIME_STAMPING",
"_required_": false,
"type": "string",
"enum": [
"TIME_STAMPING"
]
}
},
"additionalProperties": false,
"_name_": "extended_key_usage_choices",
"title": "extended_key_usage_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"ANY_EXTENDED_KEY_USAGE",
"CERTIFICATE_TRANSPARENCY",
"CLIENT_AUTH",
"CODE_SIGNING",
"EMAIL_PROTECTION",
"IPSEC_IKE",
"KERBEROS_PKINIT_KDC",
"OCSP_SIGNING",
"SERVER_AUTH",
"SMARTCARD_LOGON",
"TIME_STAMPING"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Dictionary of choices for |
certificate.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
certificate.key_type_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"RSA": {
"_name_": "RSA",
"title": "RSA",
"_required_": false,
"type": "string",
"enum": [
"RSA"
]
},
"EC": {
"_name_": "EC",
"title": "EC",
"_required_": false,
"type": "string",
"enum": [
"EC"
]
}
},
"additionalProperties": false,
"_name_": "private_key_type_choices",
"title": "private_key_type_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"RSA",
"EC"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Dictionary of supported key types for certificates. |
certificate.profiles |
---|
Return Arguments:
{
"type": "object",
"properties": {
"HTTPS RSA Certificate": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "HTTPS RSA Certificate",
"title": "HTTPS RSA Certificate",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"HTTPS ECC Certificate": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "HTTPS ECC Certificate",
"title": "HTTPS ECC Certificate",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "certificate_profiles",
"title": "certificate_profiles",
"default": {},
"_required_": false,
"_attrs_order_": [
"HTTPS RSA Certificate",
"HTTPS ECC Certificate"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns a dictionary of predefined options for specific use cases i.e openvpn client/server configurations which can be used for creating certificates. |
certificate.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_READ, CERTIFICATE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
certificate.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update certificate of `id`\nWhen `revoked` is enabled, the specified cert `id` is revoked and if it belongs to a CA chain which\nexists on this system, its serial number is added to the CA's certificate revocation list."
}
{
"type": "object",
"properties": {
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false,
"description": "When `revoked` is enabled, the specified cert `id` is revoked and if it belongs to a CA chain which\nexists on this system, its serial number is added to the CA's certificate revocation list."
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "certificate_update",
"title": "certificate_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"revoked",
"renew_days",
"add_to_trusted_store",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update certificate of `id`\nWhen `revoked` is enabled, the specified cert `id` is revoked and if it belongs to a CA chain which\nexists on this system, its serial number is added to the CA's certificate revocation list."
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false,
"description": "When `revoked` is enabled, the specified cert `id` is revoked and if it belongs to a CA chain which\nexists on this system, its serial number is added to the CA's certificate revocation list."
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic Curve Key, then default to\nusing \"SECP384R1\" curve."
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_update_returns",
"title": "certificate_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_WRITE |
Update certificate of Only name and revoked attribute can be updated. When |
Update a certificate of
|
certificateauthority.ca_sign_csr |
---|
Arguments:
{
"type": "object",
"properties": {
"ca_id": {
"type": "integer",
"_name_": "ca_id",
"title": "ca_id",
"_required_": true,
"description": "Sign CSR by Certificate Authority of `ca_id`\nSign CSR's and generate a certificate from it. `ca_id` provides which CA is to be used for signing\na CSR of `csr_cert_id` which exists in the system"
},
"csr_cert_id": {
"type": "integer",
"_name_": "csr_cert_id",
"title": "csr_cert_id",
"_required_": true,
"description": "Sign CSR's and generate a certificate from it. `ca_id` provides which CA is to be used for signing\na CSR of `csr_cert_id` which exists in the system"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"cert_extensions": {
"type": "object",
"properties": {
"BasicConstraints": {
"type": "object",
"properties": {
"ca": {
"type": "boolean",
"_name_": "ca",
"title": "ca",
"default": false,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"path_length": {
"type": [
"integer",
"null"
],
"_name_": "path_length",
"title": "path_length",
"default": null,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "BasicConstraints",
"title": "BasicConstraints",
"default": {},
"_required_": false,
"_attrs_order_": [
"ca",
"enabled",
"path_length",
"extension_critical"
]
},
"AuthorityKeyIdentifier": {
"type": "object",
"properties": {
"authority_cert_issuer": {
"type": "boolean",
"_name_": "authority_cert_issuer",
"title": "authority_cert_issuer",
"default": false,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "AuthorityKeyIdentifier",
"title": "AuthorityKeyIdentifier",
"default": {},
"_required_": false,
"_attrs_order_": [
"authority_cert_issuer",
"enabled",
"extension_critical"
]
},
"ExtendedKeyUsage": {
"type": "object",
"properties": {
"usages": {
"_name_": "usages",
"title": "usages",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "usage",
"title": "usage",
"_required_": false,
"type": "string",
"enum": [
"ANY_EXTENDED_KEY_USAGE",
"CERTIFICATE_TRANSPARENCY",
"CLIENT_AUTH",
"CODE_SIGNING",
"EMAIL_PROTECTION",
"IPSEC_IKE",
"KERBEROS_PKINIT_KDC",
"OCSP_SIGNING",
"SERVER_AUTH",
"SMARTCARD_LOGON",
"TIME_STAMPING"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ExtendedKeyUsage",
"title": "ExtendedKeyUsage",
"default": {},
"_required_": false,
"_attrs_order_": [
"usages",
"enabled",
"extension_critical"
]
},
"KeyUsage": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"digital_signature": {
"type": "boolean",
"_name_": "digital_signature",
"title": "digital_signature",
"default": false,
"_required_": false
},
"content_commitment": {
"type": "boolean",
"_name_": "content_commitment",
"title": "content_commitment",
"default": false,
"_required_": false
},
"key_encipherment": {
"type": "boolean",
"_name_": "key_encipherment",
"title": "key_encipherment",
"default": false,
"_required_": false
},
"data_encipherment": {
"type": "boolean",
"_name_": "data_encipherment",
"title": "data_encipherment",
"default": false,
"_required_": false
},
"key_agreement": {
"type": "boolean",
"_name_": "key_agreement",
"title": "key_agreement",
"default": false,
"_required_": false
},
"key_cert_sign": {
"type": "boolean",
"_name_": "key_cert_sign",
"title": "key_cert_sign",
"default": false,
"_required_": false
},
"crl_sign": {
"type": "boolean",
"_name_": "crl_sign",
"title": "crl_sign",
"default": false,
"_required_": false
},
"encipher_only": {
"type": "boolean",
"_name_": "encipher_only",
"title": "encipher_only",
"default": false,
"_required_": false
},
"decipher_only": {
"type": "boolean",
"_name_": "decipher_only",
"title": "decipher_only",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "KeyUsage",
"title": "KeyUsage",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"digital_signature",
"content_commitment",
"key_encipherment",
"data_encipherment",
"key_agreement",
"key_cert_sign",
"crl_sign",
"encipher_only",
"decipher_only",
"extension_critical"
]
}
},
"additionalProperties": false,
"_name_": "cert_extensions",
"title": "cert_extensions",
"default": {},
"_required_": false,
"_attrs_order_": [
"BasicConstraints",
"AuthorityKeyIdentifier",
"ExtendedKeyUsage",
"KeyUsage"
],
"description": "`cert_extensions` can be specified if specific extensions are to be set in the newly signed certificate."
}
},
"additionalProperties": false,
"_name_": "ca_sign_csr",
"title": "ca_sign_csr",
"default": {},
"_required_": false,
"_attrs_order_": [
"ca_id",
"csr_cert_id",
"name",
"cert_extensions"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_AUTHORITY_WRITE |
Sign CSR by Certificate Authority of Sign CSR's and generate a certificate from it.
|
Sign CSR of
|
certificateauthority.create |
---|
Arguments:
{
"type": "object",
"properties": {
"tos": {
"type": "boolean",
"_name_": "tos",
"title": "tos",
"_required_": false
},
"csr_id": {
"type": "integer",
"_name_": "csr_id",
"title": "csr_id",
"_required_": false
},
"signedby": {
"type": "integer",
"_name_": "signedby",
"title": "signedby",
"_required_": false
},
"key_length": {
"type": "integer",
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"lifetime": {
"type": "integer",
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": "integer",
"_name_": "serial",
"title": "serial",
"_required_": false
},
"acme_directory_uri": {
"_name_": "acme_directory_uri",
"title": "acme_directory_uri",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": "string"
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": "string"
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": "string"
},
"ec_curve": {
"_name_": "ec_curve",
"title": "ec_curve",
"default": "SECP384R1",
"_required_": false,
"type": "string",
"enum": [
"SECP256R1",
"SECP384R1",
"SECP521R1",
"ed25519"
],
"description": "Created certificate authorities use RSA keys by default. If an Elliptic Curve Key is desired, then it can be\nspecified with the `key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic\nCurve Key, default to using \"SECP384R1\" curve."
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": "string"
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"default": "RSA",
"_required_": false,
"type": "string",
"enum": [
"RSA",
"EC"
],
"description": "Created certificate authorities use RSA keys by default. If an Elliptic Curve Key is desired, then it can be\nspecified with the `key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic\nCurve Key, default to using \"SECP384R1\" curve."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": "string"
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": "string"
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"_required_": false,
"type": "string"
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"create_type": {
"_name_": "create_type",
"title": "create_type",
"_required_": true,
"type": "string",
"enum": [
"CA_CREATE_INTERNAL",
"CA_CREATE_IMPORTED",
"CA_CREATE_INTERMEDIATE"
],
"description": "Certificate Authorities are classified under following types with the necessary keywords to be passed\nfor `create_type` attribute to create the respective type of certificate authority\nA type is selected by the Certificate Authority Service based on `create_type`. The rest of the values\nare validated accordingly and finally a certificate is made based on the selected type."
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": "string",
"enum": [
"SHA224",
"SHA256",
"SHA384",
"SHA512"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "san",
"title": "san",
"_required_": false,
"type": "string"
}
]
},
"cert_extensions": {
"type": "object",
"properties": {
"BasicConstraints": {
"type": "object",
"properties": {
"ca": {
"type": "boolean",
"_name_": "ca",
"title": "ca",
"default": true,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"path_length": {
"type": [
"integer",
"null"
],
"_name_": "path_length",
"title": "path_length",
"default": null,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "BasicConstraints",
"title": "BasicConstraints",
"default": {},
"_required_": false,
"_attrs_order_": [
"ca",
"enabled",
"path_length",
"extension_critical"
]
},
"AuthorityKeyIdentifier": {
"type": "object",
"properties": {
"authority_cert_issuer": {
"type": "boolean",
"_name_": "authority_cert_issuer",
"title": "authority_cert_issuer",
"default": false,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "AuthorityKeyIdentifier",
"title": "AuthorityKeyIdentifier",
"default": {},
"_required_": false,
"_attrs_order_": [
"authority_cert_issuer",
"enabled",
"extension_critical"
]
},
"ExtendedKeyUsage": {
"type": "object",
"properties": {
"usages": {
"_name_": "usages",
"title": "usages",
"default": [
"SERVER_AUTH"
],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "usage",
"title": "usage",
"_required_": false,
"type": "string",
"enum": [
"ANY_EXTENDED_KEY_USAGE",
"CERTIFICATE_TRANSPARENCY",
"CLIENT_AUTH",
"CODE_SIGNING",
"EMAIL_PROTECTION",
"IPSEC_IKE",
"KERBEROS_PKINIT_KDC",
"OCSP_SIGNING",
"SERVER_AUTH",
"SMARTCARD_LOGON",
"TIME_STAMPING"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ExtendedKeyUsage",
"title": "ExtendedKeyUsage",
"default": {},
"_required_": false,
"_attrs_order_": [
"usages",
"enabled",
"extension_critical"
]
},
"KeyUsage": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"digital_signature": {
"type": "boolean",
"_name_": "digital_signature",
"title": "digital_signature",
"default": false,
"_required_": false
},
"content_commitment": {
"type": "boolean",
"_name_": "content_commitment",
"title": "content_commitment",
"default": false,
"_required_": false
},
"key_encipherment": {
"type": "boolean",
"_name_": "key_encipherment",
"title": "key_encipherment",
"default": false,
"_required_": false
},
"data_encipherment": {
"type": "boolean",
"_name_": "data_encipherment",
"title": "data_encipherment",
"default": false,
"_required_": false
},
"key_agreement": {
"type": "boolean",
"_name_": "key_agreement",
"title": "key_agreement",
"default": false,
"_required_": false
},
"key_cert_sign": {
"type": "boolean",
"_name_": "key_cert_sign",
"title": "key_cert_sign",
"default": true,
"_required_": false
},
"crl_sign": {
"type": "boolean",
"_name_": "crl_sign",
"title": "crl_sign",
"default": true,
"_required_": false
},
"encipher_only": {
"type": "boolean",
"_name_": "encipher_only",
"title": "encipher_only",
"default": false,
"_required_": false
},
"decipher_only": {
"type": "boolean",
"_name_": "decipher_only",
"title": "decipher_only",
"default": false,
"_required_": false
},
"extension_critical": {
"type": "boolean",
"_name_": "extension_critical",
"title": "extension_critical",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "KeyUsage",
"title": "KeyUsage",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"digital_signature",
"content_commitment",
"key_encipherment",
"data_encipherment",
"key_agreement",
"key_cert_sign",
"crl_sign",
"encipher_only",
"decipher_only",
"extension_critical"
]
}
},
"additionalProperties": false,
"_name_": "cert_extensions",
"title": "cert_extensions",
"default": {},
"_required_": false,
"_attrs_order_": [
"BasicConstraints",
"AuthorityKeyIdentifier",
"ExtendedKeyUsage",
"KeyUsage"
],
"description": "`cert_extensions` can be specified to set X509v3 extensions."
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ca_create",
"title": "ca_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"tos",
"csr_id",
"signedby",
"key_length",
"renew_days",
"type",
"lifetime",
"serial",
"acme_directory_uri",
"certificate",
"city",
"common",
"country",
"CSR",
"ec_curve",
"email",
"key_type",
"name",
"organization",
"organizational_unit",
"passphrase",
"privatekey",
"state",
"create_type",
"digest_algorithm",
"san",
"cert_extensions",
"add_to_trusted_store"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
],
"description": "Created certificate authorities use RSA keys by default. If an Elliptic Curve Key is desired, then it can be\nspecified with the `key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic\nCurve Key, default to using \"SECP384R1\" curve."
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_create_returns",
"title": "certificateauthority_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_AUTHORITY_WRITE |
Create a new Certificate Authority Certificate Authorities are classified under following types with the necessary keywords to be passed
for 1) Internal Certificate Authority - CA_CREATE_INTERNAL 2) Imported Certificate Authority - CA_CREATE_IMPORTED 3) Intermediate Certificate Authority - CA_CREATE_INTERMEDIATE Created certificate authorities use RSA keys by default. If an Elliptic Curve Key is desired, then it can be
specified with the A type is selected by the Certificate Authority Service based on
|
Create an Internal Certificate Authority
Create an Imported Certificate Authority
|
certificateauthority.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete a Certificate Authority of `id`"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_AUTHORITY_WRITE |
Delete a Certificate Authority of |
Delete a Certificate Authority of
|
certificateauthority.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_AUTHORITY_READ, CERTIFICATE_AUTHORITY_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
certificateauthority.profiles |
---|
Return Arguments:
{
"type": "object",
"properties": {
"CA": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "CA",
"title": "CA",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "certificate_authority_profiles",
"title": "certificate_authority_profiles",
"default": {},
"_required_": false,
"_attrs_order_": [
"CA"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_AUTHORITY_READ, CERTIFICATE_AUTHORITY_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns a dictionary of predefined options for specific use cases i.e OpenVPN certificate authority configurations which can be used for creating certificate authorities. |
certificateauthority.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_AUTHORITY_READ, CERTIFICATE_AUTHORITY_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
certificateauthority.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update Certificate Authority of `id`"
}
{
"type": "object",
"properties": {
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false,
"description": "Only `name` and `revoked` attribute can be updated.\nIf `revoked` is enabled, the CA and its complete chain is marked as revoked and added to the CA's\ncertificate revocation list."
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"_required_": false
},
"ca_id": {
"type": "integer",
"_name_": "ca_id",
"title": "ca_id",
"_required_": false
},
"csr_cert_id": {
"type": "integer",
"_name_": "csr_cert_id",
"title": "csr_cert_id",
"_required_": false
},
"create_type": {
"_name_": "create_type",
"title": "create_type",
"_required_": false,
"type": "string",
"enum": [
"CA_SIGN_CSR"
],
"description": "Certificate Authorities are classified under following types with the necessary keywords to be passed\nfor `create_type` attribute to create the respective type of certificate authority\nA type is selected by the Certificate Authority Service based on `create_type`. The rest of the values\nare validated accordingly and finally a certificate is made based on the selected type."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string",
"description": "Only `name` and `revoked` attribute can be updated."
}
},
"additionalProperties": false,
"_name_": "ca_update",
"title": "ca_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"revoked",
"add_to_trusted_store",
"ca_id",
"csr_cert_id",
"create_type",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Certificate Authority of `id`"
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string",
"description": "Only `name` and `revoked` attribute can be updated."
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false,
"description": "Only `name` and `revoked` attribute can be updated.\nIf `revoked` is enabled, the CA and its complete chain is marked as revoked and added to the CA's\ncertificate revocation list."
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
],
"description": "Created certificate authorities use RSA keys by default. If an Elliptic Curve Key is desired, then it can be\nspecified with the `key_type` attribute. If the `ec_curve` attribute is not specified for the Elliptic\nCurve Key, default to using \"SECP384R1\" curve."
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_update_returns",
"title": "certificateauthority_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
|
This method is accessible to the users granted with the following roles: CERTIFICATE_AUTHORITY_WRITE |
Update Certificate Authority of Only If |
Update a Certificate Authority of
|
cloud_backup.abort |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Aborts cloud backup task. |
cloud_backup.create |
---|
Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"credentials": {
"type": "integer",
"_name_": "credentials",
"title": "credentials",
"_required_": true
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "cloud_backup_create",
"title": "cloud_backup_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"credentials",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_create_returns",
"title": "cloud_backup_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last",
"id",
"credentials",
"job",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_BACKUP_WRITE |
cloud_backup.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CLOUD_BACKUP_WRITE |
Deletes cloud backup entry |
cloud_backup.delete_snapshot
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"_name_": "snapshot_id",
"title": "snapshot_id",
"_required_": false,
"type": "string"
}
|
Delete snapshot |
cloud_backup.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_entry",
"title": "cloud_backup_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last",
"id",
"credentials",
"job",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_BACKUP_READ, CLOUD_BACKUP_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
cloud_backup.list_snapshot_directory |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"_name_": "snapshot_id",
"title": "snapshot_id",
"_required_": false,
"type": "string"
}
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "cloud_backup_snapshot_items",
"title": "cloud_backup_snapshot_items",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"dir",
"file"
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
},
"mtime": {
"_name_": "mtime",
"title": "mtime",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "cloud_backup_snapshot_item",
"title": "cloud_backup_snapshot_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"path",
"type",
"size",
"mtime"
]
}
]
}
|
List files in the directory |
cloud_backup.list_snapshots |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"_name_": "cloud_backup_snapshots",
"title": "cloud_backup_snapshots",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": false,
"type": "string"
},
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"paths": {
"_name_": "paths",
"title": "paths",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": true,
"_name_": "cloud_backup_snapshot",
"title": "cloud_backup_snapshot",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"hostname",
"time",
"paths"
]
}
]
}
|
List existing snapshots for the cloud backup job |
cloud_backup.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_entry",
"title": "cloud_backup_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last",
"id",
"credentials",
"job",
"locked"
]
}
]
},
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_entry",
"title": "cloud_backup_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last",
"id",
"credentials",
"job",
"locked"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_entry",
"title": "cloud_backup_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last",
"id",
"credentials",
"job",
"locked"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CLOUD_BACKUP_READ, CLOUD_BACKUP_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
cloud_backup.restore
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"_name_": "snapshot_id",
"title": "snapshot_id",
"_required_": false,
"type": "string"
}
{
"_name_": "subfolder",
"title": "subfolder",
"_required_": false,
"type": "string"
}
{
"_name_": "destination_path",
"title": "destination_path",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "item",
"title": "item",
"_required_": false,
"type": "string"
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "item",
"title": "item",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"exclude",
"include"
]
}
|
Restore files to the directory |
cloud_backup.sync
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"dry_run": {
"type": "boolean",
"_name_": "dry_run",
"title": "dry_run",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_sync_options",
"title": "cloud_backup_sync_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"dry_run"
]
}
|
Run the cloud backup job |
cloud_backup.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"credentials": {
"type": "integer",
"_name_": "credentials",
"title": "credentials",
"_required_": true
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "cloud_backup_update",
"title": "cloud_backup_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"credentials",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_update_returns",
"title": "cloud_backup_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last",
"id",
"credentials",
"job",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_BACKUP_WRITE |
Updates the cloud backup entry |
cloudsync.abort |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Aborts cloud sync task. |
cloudsync.create |
---|
Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"credentials": {
"type": "integer",
"_name_": "credentials",
"title": "credentials",
"_required_": true
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_create",
"title": "cloud_sync_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"credentials",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloudsync_create_returns",
"title": "cloudsync_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks",
"id",
"credentials",
"job",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Creates a new cloud_sync entry. |
Create a new cloud_sync using amazon s3 attributes, which is supposed to run every hour.
|
cloudsync.create_bucket |
---|
Arguments:
{
"type": "integer",
"_name_": "credentials_id",
"title": "credentials_id",
"_required_": false
}
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Creates a new bucket |
cloudsync.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Deletes cloud_sync entry |
cloudsync.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_entry",
"title": "cloud_sync_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks",
"id",
"credentials",
"job",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_READ, CLOUD_SYNC_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
cloudsync.list_buckets |
---|
Arguments:
{
"type": "integer",
"_name_": "credentials_id",
"title": "credentials_id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
- |
cloudsync.list_directory |
---|
Arguments:
{
"type": "object",
"properties": {
"credentials": {
"type": "integer",
"_name_": "credentials",
"title": "credentials",
"_required_": true
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": [],
"description": "If remote supports buckets, path is constructed by two keys \"bucket\"/\"folder\" in `attributes`.\nIf remote does not support buckets, path is constructed using \"folder\" key only in `attributes`.\n\"folder\" is directory name and \"bucket\" is bucket name for remote."
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "cloud_sync_ls",
"title": "cloud_sync_ls",
"default": {},
"_required_": false,
"_attrs_order_": [
"credentials",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"attributes",
"args"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
List contents of a remote bucket / directory. If remote supports buckets, path is constructed by two keys "bucket"/"folder" in Path examples: S3 Service
Dropbox Service
|
cloudsync.providers |
---|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_READ, CLOUD_SYNC_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns a list of dictionaries of supported providers for Cloud Sync Tasks.
Example of a single provider: [ { "name": "AMAZON_CLOUD_DRIVE", "title": "Amazon Cloud Drive", "credentials_schema": [ { "property": "client_id", "schema": { "title": "Amazon Application Client ID", "required": true, "type": "string" } }, { "property": "client_secret", "schema": { "title": "Application Key", "required": true, "type": "string" } } ], "credentials_oauth": null, "buckets": false, "bucket_title": "Bucket", "task_schema": [] } ] |
cloudsync.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_entry",
"title": "cloud_sync_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks",
"id",
"credentials",
"job",
"locked"
]
}
]
},
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_entry",
"title": "cloud_sync_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks",
"id",
"credentials",
"job",
"locked"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_entry",
"title": "cloud_sync_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks",
"id",
"credentials",
"job",
"locked"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_READ, CLOUD_SYNC_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
cloudsync.restore |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY"
]
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "cloud_sync_restore",
"title": "cloud_sync_restore",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"transfer_mode",
"path"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Create the opposite of cloud sync task |
cloudsync.sync
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"dry_run": {
"type": "boolean",
"_name_": "dry_run",
"title": "dry_run",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_sync_options",
"title": "cloud_sync_sync_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"dry_run"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Run the cloud_sync job |
cloudsync.sync_onetime
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"credentials": {
"type": "integer",
"_name_": "credentials",
"title": "credentials",
"_required_": true
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_sync_onetime",
"title": "cloud_sync_sync_onetime",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"credentials",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks"
]
}
{
"type": "object",
"properties": {
"dry_run": {
"type": "boolean",
"_name_": "dry_run",
"title": "dry_run",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_sync_onetime_options",
"title": "cloud_sync_sync_onetime_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"dry_run"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Run cloud sync task without creating it. |
cloudsync.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Updates the cloud_sync entry `id` with `data`.\nCreates a new cloud_sync entry."
}
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"credentials": {
"type": "integer",
"_name_": "credentials",
"title": "credentials",
"_required_": true
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_update",
"title": "cloud_sync_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"credentials",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Updates the cloud_sync entry `id` with `data`.\nCreates a new cloud_sync entry."
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloudsync_update_returns",
"title": "cloudsync_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks",
"id",
"credentials",
"job",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Updates the cloud_sync entry |
cloudsync.credentials.create |
---|
Arguments:
{
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
},
"required": [
"name",
"provider",
"attributes"
],
"title": "cloud_sync_credentials_create",
"type": "object",
"_name_": "cloud_sync_credentials_create",
"_required_": true,
"_attrs_order_": [
"name",
"provider",
"attributes"
]
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"name": {
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
},
"required": [
"id",
"name",
"provider",
"attributes"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"id",
"name",
"provider",
"attributes"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Create Cloud Sync Credentials.
|
cloudsync.credentials.delete |
---|
Arguments:
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
}
|
Return Arguments:
{
"title": "result",
"type": "boolean",
"_name_": "result",
"_required_": true
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Delete Cloud Sync Credentials of |
cloudsync.credentials.get_instance |
---|
Arguments:
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
}
{
"allOf": [
{
"additionalProperties": false,
"properties": {
"relationships": {
"default": true,
"title": "relationships",
"type": "boolean",
"_name_": "relationships",
"_required_": false
},
"extend": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend",
"_name_": "extend",
"_required_": false
},
"extend_context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend_context",
"_name_": "extend_context",
"_required_": false
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "prefix",
"_name_": "prefix",
"_required_": false
},
"extra": {
"default": {},
"title": "extra",
"type": "object",
"_name_": "extra",
"_required_": false
},
"order_by": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "order_by",
"type": "array",
"_name_": "order_by",
"_required_": false
},
"select": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "select",
"type": "array",
"_name_": "select",
"_required_": false
},
"count": {
"default": false,
"title": "count",
"type": "boolean",
"_name_": "count",
"_required_": false
},
"get": {
"default": false,
"title": "get",
"type": "boolean",
"_name_": "get",
"_required_": false
},
"offset": {
"default": 0,
"title": "offset",
"type": "integer",
"_name_": "offset",
"_required_": false
},
"limit": {
"default": 0,
"title": "limit",
"type": "integer",
"_name_": "limit",
"_required_": false
},
"force_sql_filters": {
"default": false,
"title": "force_sql_filters",
"type": "boolean",
"_name_": "force_sql_filters",
"_required_": false
}
},
"title": "QueryOptions",
"type": "object",
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
],
"default": {},
"title": "options",
"_name_": "options",
"_required_": false
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"name": {
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
},
"required": [
"id",
"name",
"provider",
"attributes"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"id",
"name",
"provider",
"attributes"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_READ, CLOUD_SYNC_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
cloudsync.credentials.query |
---|
Arguments:
{
"default": [],
"items": [
{}
],
"title": "filters",
"type": "array",
"_name_": "filters",
"_required_": false
}
{
"allOf": [
{
"additionalProperties": false,
"properties": {
"relationships": {
"default": true,
"title": "relationships",
"type": "boolean",
"_name_": "relationships",
"_required_": false
},
"extend": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend",
"_name_": "extend",
"_required_": false
},
"extend_context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend_context",
"_name_": "extend_context",
"_required_": false
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "prefix",
"_name_": "prefix",
"_required_": false
},
"extra": {
"default": {},
"title": "extra",
"type": "object",
"_name_": "extra",
"_required_": false
},
"order_by": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "order_by",
"type": "array",
"_name_": "order_by",
"_required_": false
},
"select": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "select",
"type": "array",
"_name_": "select",
"_required_": false
},
"count": {
"default": false,
"title": "count",
"type": "boolean",
"_name_": "count",
"_required_": false
},
"get": {
"default": false,
"title": "get",
"type": "boolean",
"_name_": "get",
"_required_": false
},
"offset": {
"default": 0,
"title": "offset",
"type": "integer",
"_name_": "offset",
"_required_": false
},
"limit": {
"default": 0,
"title": "limit",
"type": "integer",
"_name_": "limit",
"_required_": false
},
"force_sql_filters": {
"default": false,
"title": "force_sql_filters",
"type": "boolean",
"_name_": "force_sql_filters",
"_required_": false
}
},
"title": "QueryOptions",
"type": "object",
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
],
"default": {
"relationships": true,
"extend": null,
"extend_context": null,
"prefix": null,
"extra": {},
"order_by": [],
"select": [],
"count": false,
"get": false,
"offset": 0,
"limit": 0,
"force_sql_filters": false
},
"title": "options",
"_name_": "options",
"_required_": false
}
|
Return Arguments:
{
"anyOf": [
{
"items": [
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"name": {
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
},
"required": [
"id",
"name",
"provider",
"attributes"
],
"title": "CloudCredentialEntry",
"type": "object",
"_attrs_order_": [
"id",
"name",
"provider",
"attributes"
]
}
],
"type": "array"
},
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"name": {
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
},
"required": [
"id",
"name",
"provider",
"attributes"
],
"title": "CloudCredentialEntry",
"type": "object",
"_attrs_order_": [
"id",
"name",
"provider",
"attributes"
]
},
{
"type": "integer"
}
],
"title": "result",
"_name_": "result",
"_required_": true
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_READ, CLOUD_SYNC_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
cloudsync.credentials.update |
---|
Arguments:
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
}
{
"additionalProperties": false,
"properties": {
"name": {
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": false
},
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": false
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": false
}
},
"title": "cloud_sync_credentials_update",
"type": "object",
"_name_": "cloud_sync_credentials_update",
"_required_": true,
"_attrs_order_": [
"name",
"provider",
"attributes"
]
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"name": {
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
},
"required": [
"id",
"name",
"provider",
"attributes"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"id",
"name",
"provider",
"attributes"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Update Cloud Sync Credentials of |
cloudsync.credentials.verify |
---|
Arguments:
{
"additionalProperties": false,
"properties": {
"provider": {
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
"attributes": {
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
},
"required": [
"provider",
"attributes"
],
"title": "cloud_sync_credentials_create",
"type": "object",
"_name_": "cloud_sync_credentials_create",
"_required_": true,
"_attrs_order_": [
"provider",
"attributes"
]
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"valid": {
"title": "valid",
"type": "boolean",
"_name_": "valid",
"_required_": true
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "error",
"_name_": "error",
"_required_": false
},
"excerpt": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "excerpt",
"_name_": "excerpt",
"_required_": false
}
},
"required": [
"valid"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"valid",
"error",
"excerpt"
]
}
|
This method is accessible to the users granted with the following roles: CLOUD_SYNC_WRITE |
Verify if |
config.reset
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"reboot": {
"type": "boolean",
"_name_": "reboot",
"title": "reboot",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"reboot"
]
}
|
Reset database to configuration defaults. If |
config.save |
---|
Arguments:
{
"type": "object",
"properties": {
"secretseed": {
"type": "boolean",
"_name_": "secretseed",
"title": "secretseed",
"default": false,
"_required_": false,
"description": "`secretseed` bool: When true, include password secret seed."
},
"pool_keys": {
"type": "boolean",
"_name_": "pool_keys",
"title": "pool_keys",
"default": false,
"_required_": false,
"description": "`pool_keys` bool: IGNORED and DEPRECATED as it does not apply on SCALE systems."
},
"root_authorized_keys": {
"type": "boolean",
"_name_": "root_authorized_keys",
"title": "root_authorized_keys",
"default": false,
"_required_": false,
"description": "`root_authorized_keys` bool: When true, include \"/root/.ssh/authorized_keys\" file for the root user."
}
},
"additionalProperties": false,
"_name_": "configsave",
"title": "configsave",
"default": {},
"_required_": false,
"_attrs_order_": [
"secretseed",
"pool_keys",
"root_authorized_keys"
]
}
|
Create a tar file of security-sensitive information. These options select which information is included in the tar file:
If none of these options are set, the tar file is not generated and the database file is returned. |
config.upload |
---|
Accepts a configuration file via job pipe. |
core.arp |
---|
Arguments:
{
"type": "object",
"properties": {
"ip": {
"_name_": "ip",
"title": "ip",
"default": null,
"_required_": false,
"type": "string"
},
"interface": {
"_name_": "interface",
"title": "interface",
"default": null,
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ip",
"interface"
]
}
|
- |
core.bulk
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "method",
"title": "method",
"_required_": false,
"type": "string",
"description": "Will sequentially call `method` with arguments from the `params` list. For example, running"
}
{
"_name_": "params",
"title": "params",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "params",
"title": "params",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
],
"description": "Will sequentially call `method` with arguments from the `params` list. For example, running"
}
{
"_name_": "description",
"title": "description",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
|
Will sequentially call
will call
If the first call fails and the seconds succeeds (returning
Important note: the execution status of
|
core.debug |
---|
Arguments:
{
"type": "object",
"properties": {
"bind_address": {
"_name_": "bind_address",
"title": "bind_address",
"default": "0.0.0.0",
"_required_": false,
"type": "string"
},
"bind_port": {
"type": "integer",
"_name_": "bind_port",
"title": "bind_port",
"default": 3000,
"_required_": false
},
"threaded": {
"type": "boolean",
"_name_": "threaded",
"title": "threaded",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"bind_address",
"bind_port",
"threaded"
]
}
|
Setup middlewared for remote debugging. engine currently used: - REMOTE_PDB: Remote vanilla PDB (over TCP sockets) options: - bind_address: local ip address to bind the remote debug session to - bind_port: local port to listen on - threaded: run debugger in a new thread instead of the main event loop |
core.debug_mode_enabled |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "debug_mode_enabled",
"title": "debug_mode_enabled",
"_required_": false
}
|
- |
core.download |
---|
Arguments:
{
"_name_": "method",
"title": "method",
"_required_": false,
"type": "string"
}
{
"_name_": "args",
"title": "args",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
{
"_name_": "filename",
"title": "filename",
"_required_": false,
"type": "string"
}
{
"type": "boolean",
"_name_": "buffered",
"title": "buffered",
"default": false,
"_required_": false,
"description": "Non-`buffered` downloads will allow job to write to pipe as soon as download URL is requested, job will stay\nblocked meanwhile. `buffered` downloads must wait for job to complete before requesting download URL, job's\npipe output will be buffered to ramfs."
}
|
Core helper to call a job marked for download. Non- Returns the job id and the URL for download. |
core.get_events |
---|
Returns metadata for every possible event emitted from websocket server. |
core.get_jobs |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"method": {
"_name_": "method",
"title": "method",
"_required_": false,
"type": "string"
},
"arguments": {
"_name_": "arguments",
"title": "arguments",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"transient": {
"type": "boolean",
"_name_": "transient",
"title": "transient",
"_required_": false
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": [
"string",
"null"
]
},
"abortable": {
"type": "boolean",
"_name_": "abortable",
"title": "abortable",
"_required_": false
},
"logs_path": {
"_name_": "logs_path",
"title": "logs_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"logs_excerpt": {
"_name_": "logs_excerpt",
"title": "logs_excerpt",
"_required_": false,
"type": [
"string",
"null"
]
},
"progress": {
"type": "object",
"properties": {
"percent": {
"type": [
"integer",
"null"
],
"_name_": "percent",
"title": "percent",
"_required_": false
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "extra",
"title": "extra",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "progress",
"title": "progress",
"default": {},
"_required_": false,
"_attrs_order_": [
"percent",
"description",
"extra"
]
},
"result": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "result",
"title": "result",
"_required_": false
},
"error": {
"_name_": "error",
"title": "error",
"_required_": false,
"type": [
"string",
"null"
]
},
"exception": {
"_name_": "exception",
"title": "exception",
"_required_": false,
"type": [
"string",
"null"
]
},
"exc_info": {
"type": "object",
"properties": {
"repr": {
"_name_": "repr",
"title": "repr",
"_required_": false,
"type": [
"string",
"null"
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": [
"string",
"null"
]
},
"errno": {
"type": [
"integer",
"null"
],
"_name_": "errno",
"title": "errno",
"_required_": false
},
"extra": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "extra",
"title": "extra",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exc_info",
"title": "exc_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"repr",
"type",
"errno",
"extra"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"time_started": {
"_name_": "time_started",
"title": "time_started",
"_required_": false,
"type": [
"string",
"null"
]
},
"time_finished": {
"_name_": "time_finished",
"title": "time_finished",
"_required_": false,
"type": [
"string",
"null"
]
},
"credentials": {
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
},
"data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "data",
"title": "data",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"data"
]
}
},
"additionalProperties": false,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"method",
"arguments",
"transient",
"description",
"abortable",
"logs_path",
"logs_excerpt",
"progress",
"result",
"error",
"exception",
"exc_info",
"state",
"time_started",
"time_finished",
"credentials"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"method": {
"_name_": "method",
"title": "method",
"_required_": false,
"type": "string"
},
"arguments": {
"_name_": "arguments",
"title": "arguments",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"transient": {
"type": "boolean",
"_name_": "transient",
"title": "transient",
"_required_": false
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": [
"string",
"null"
]
},
"abortable": {
"type": "boolean",
"_name_": "abortable",
"title": "abortable",
"_required_": false
},
"logs_path": {
"_name_": "logs_path",
"title": "logs_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"logs_excerpt": {
"_name_": "logs_excerpt",
"title": "logs_excerpt",
"_required_": false,
"type": [
"string",
"null"
]
},
"progress": {
"type": "object",
"properties": {
"percent": {
"type": [
"integer",
"null"
],
"_name_": "percent",
"title": "percent",
"_required_": false
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "extra",
"title": "extra",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "progress",
"title": "progress",
"default": {},
"_required_": false,
"_attrs_order_": [
"percent",
"description",
"extra"
]
},
"result": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "result",
"title": "result",
"_required_": false
},
"error": {
"_name_": "error",
"title": "error",
"_required_": false,
"type": [
"string",
"null"
]
},
"exception": {
"_name_": "exception",
"title": "exception",
"_required_": false,
"type": [
"string",
"null"
]
},
"exc_info": {
"type": "object",
"properties": {
"repr": {
"_name_": "repr",
"title": "repr",
"_required_": false,
"type": [
"string",
"null"
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": [
"string",
"null"
]
},
"errno": {
"type": [
"integer",
"null"
],
"_name_": "errno",
"title": "errno",
"_required_": false
},
"extra": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "extra",
"title": "extra",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exc_info",
"title": "exc_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"repr",
"type",
"errno",
"extra"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"time_started": {
"_name_": "time_started",
"title": "time_started",
"_required_": false,
"type": [
"string",
"null"
]
},
"time_finished": {
"_name_": "time_finished",
"title": "time_finished",
"_required_": false,
"type": [
"string",
"null"
]
},
"credentials": {
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
},
"data": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "data",
"title": "data",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"data"
]
}
},
"additionalProperties": false,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"method",
"arguments",
"transient",
"description",
"abortable",
"logs_path",
"logs_excerpt",
"progress",
"result",
"error",
"exception",
"exc_info",
"state",
"time_started",
"time_finished",
"credentials"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
Get information about long-running jobs. If authenticated session does not have the FULL_ADMIN role, only jobs owned by the current authenticated session will be returned.
Redaction behavior may be explicitly specfied via the |
core.job_abort |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
- |
core.job_download_logs |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Download logs of the job `id`."
}
{
"_name_": "filename",
"title": "filename",
"_required_": false,
"type": "string"
}
{
"type": "boolean",
"_name_": "buffered",
"title": "buffered",
"default": false,
"_required_": false
}
|
Download logs of the job Please see |
core.job_wait
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
- |
core.ping |
---|
Utility method which just returns "pong". Can be used to keep connection/authtoken alive instead of using "ping" protocol message. |
core.ping_remote |
---|
Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "ICMP",
"_required_": false,
"type": "string",
"enum": [
"ICMP",
"ICMPV4",
"ICMPV6"
]
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 4,
"_required_": false
},
"count": {
"type": "integer",
"_name_": "count",
"title": "count",
"default": null,
"_required_": false
},
"interface": {
"_name_": "interface",
"title": "interface",
"default": null,
"_required_": false,
"type": "string"
},
"interval": {
"_name_": "interval",
"title": "interval",
"default": null,
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"hostname",
"timeout",
"count",
"interface",
"interval"
]
}
|
Method that will send an ICMP echo request to "hostname" and will wait up to "timeout" for a reply. |
core.resize_shell |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
{
"type": "integer",
"_name_": "cols",
"title": "cols",
"_required_": false
}
{
"type": "integer",
"_name_": "rows",
"title": "rows",
"_required_": false
}
|
Resize terminal session (/websocket/shell) to cols x rows |
core.sessions |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"socket_family": {
"_name_": "socket_family",
"title": "socket_family",
"_required_": false,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"authenticated": {
"type": "boolean",
"_name_": "authenticated",
"title": "authenticated",
"_required_": false
},
"call_count": {
"type": "integer",
"_name_": "call_count",
"title": "call_count",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "session",
"title": "session",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"socket_family",
"address",
"authenticated",
"call_count"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"socket_family": {
"_name_": "socket_family",
"title": "socket_family",
"_required_": false,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"authenticated": {
"type": "boolean",
"_name_": "authenticated",
"title": "authenticated",
"_required_": false
},
"call_count": {
"type": "integer",
"_name_": "call_count",
"title": "call_count",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "session",
"title": "session",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"socket_family",
"address",
"authenticated",
"call_count"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
Get currently open websocket sessions. |
core.set_debug_mode |
---|
Arguments:
{
"type": "boolean",
"_name_": "debug_mode",
"title": "debug_mode",
"_required_": false
}
|
Set |
cronjob.create |
---|
Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "cron_job_create",
"title": "cron_job_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cronjob_create_returns",
"title": "cronjob_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user",
"id"
]
}
|
Create a new cron job.
|
Create a cron job which executes
|
cronjob.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete cronjob of |
cronjob.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "cron_job_entry",
"title": "cron_job_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
cronjob.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cron_job_entry",
"title": "cron_job_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cron_job_entry",
"title": "cron_job_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cron_job_entry",
"title": "cron_job_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
cronjob.run
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "boolean",
"_name_": "skip_disabled",
"title": "skip_disabled",
"default": false,
"_required_": false
}
|
Job to run cronjob task of |
cronjob.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update cronjob of `id`.\nCreate a new cron job."
}
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "cronjob_update",
"title": "cronjob_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false,
"description": "`stderr` and `stdout` are boolean values which if `true`, represent that we would like to suppress\nstandard error / standard output respectively."
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update cronjob of `id`.\nCreate a new cron job."
}
},
"additionalProperties": false,
"_name_": "cronjob_update_returns",
"title": "cronjob_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user",
"id"
]
}
|
Update cronjob of |
device.get_info |
---|
Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"SERIAL",
"DISK",
"GPU"
]
},
"get_partitions": {
"type": "boolean",
"_name_": "get_partitions",
"title": "get_partitions",
"default": false,
"_required_": false
},
"serials_only": {
"type": "boolean",
"_name_": "serials_only",
"title": "serials_only",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "data",
"title": "data",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"get_partitions",
"serials_only"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "serial_info",
"title": "serial_info",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"location": {
"_name_": "location",
"title": "location",
"_required_": false,
"type": "string"
},
"drivername": {
"_name_": "drivername",
"title": "drivername",
"_required_": false,
"type": "string"
},
"start": {
"_name_": "start",
"title": "start",
"_required_": false,
"type": "string"
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "serial_info",
"title": "serial_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"location",
"drivername",
"start",
"size",
"description"
]
}
]
},
{
"_name_": "gpu_info",
"title": "gpu_info",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"addr": {
"type": "object",
"properties": {
"pci_slot": {
"_name_": "pci_slot",
"title": "pci_slot",
"_required_": true,
"type": "string"
},
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": true,
"type": "string"
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"slot": {
"_name_": "slot",
"title": true,
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "addr",
"title": "addr",
"default": {},
"_required_": false,
"_attrs_order_": [
"pci_slot",
"domain",
"bus",
"slot"
]
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"pci_id": {
"_name_": "pci_id",
"title": "pci_id",
"_required_": true,
"type": "string"
},
"pci_slot": {
"_name_": "pci_slot",
"title": "pci_slot",
"_required_": true,
"type": "string"
},
"vm_pci_slot": {
"_name_": "vm_pci_slot",
"title": "vm_pci_slot",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "gpu_device",
"title": "gpu_device",
"default": {},
"_required_": false,
"_attrs_order_": [
"pci_id",
"pci_slot",
"vm_pci_slot"
]
}
]
},
"vendor": {
"_name_": "vendor",
"title": "vendor",
"_required_": true,
"type": [
"string",
"null"
]
},
"available_to_host": {
"type": "boolean",
"_name_": "available_to_host",
"title": "available_to_host",
"_required_": true
},
"uses_system_critical_devices": {
"type": "boolean",
"_name_": "uses_system_critical_devices",
"title": "uses_system_critical_devices",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "gpu_info",
"title": "gpu_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"addr",
"description",
"devices",
"vendor",
"available_to_host",
"uses_system_critical_devices"
]
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "disk_info",
"title": "disk_info",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "device_info",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Get info for If |
device.gpu_pci_ids_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "gpu_pci_id_choices",
"title": "gpu_pci_id_choices",
"description": "Returns PCI id(s) of GPU(s) located in the system\n\nExample(s):\n```\n{\n \"Red Hat, Inc. QXL paravirtual graphic card\": \"0000:00:02.0\"\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Retrieve choices for GPU PCI ids located in the system. |
directoryservices.cache_refresh
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
This method refreshes the directory services cache for users and groups that is
used as a backing for A cache refresh is not required in order to use newly-added users and groups for in permissions and ACL related methods. Likewise, a cache refresh will not resolve issues with users being unable to authenticate to shares. |
directoryservices.get_state |
---|
Return Arguments:
{
"type": "object",
"properties": {
"activedirectory": {
"_name_": "activedirectory",
"title": "activedirectory",
"_required_": false,
"type": "string",
"enum": [
"DISABLED",
"FAULTED",
"LEAVING",
"JOINING",
"HEALTHY"
]
},
"ldap": {
"_name_": "ldap",
"title": "ldap",
"_required_": false,
"type": "string",
"enum": [
"DISABLED",
"FAULTED",
"LEAVING",
"JOINING",
"HEALTHY"
]
}
},
"additionalProperties": false,
"_name_": "directory_services_states",
"title": "directory_services_states",
"default": {},
"_required_": false,
"_attrs_order_": [
"activedirectory",
"ldap"
]
}
|
|
directoryservices.status |
---|
Return Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"ACTIVEDIRECTORY",
"IPA",
"LDAP"
]
},
"status": {
"_name_": "status",
"title": "status",
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"DISABLED",
"FAULTED",
"LEAVING",
"JOINING",
"HEALTHY"
]
},
"status_msg": {
"_name_": "status_msg",
"title": "status_msg",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "directoryservices_status",
"title": "directoryservices_status",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"status",
"status_msg"
]
}
|
Provide the type and status of the currently-enabled directory service |
disk.details |
---|
Arguments:
{
"type": "object",
"properties": {
"join_partitions": {
"type": "boolean",
"_name_": "join_partitions",
"title": "join_partitions",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "BOTH",
"_required_": false,
"type": "string",
"enum": [
"USED",
"UNUSED",
"BOTH"
]
}
},
"additionalProperties": false,
"_name_": "disk_details_args",
"title": "disk_details_args",
"default": {},
"_required_": false,
"_attrs_order_": [
"join_partitions",
"type"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Return detailed information for all disks on the system.
|
disk.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"subsystem": {
"_name_": "subsystem",
"title": "subsystem",
"_required_": true,
"type": "string"
},
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"serial": {
"_name_": "serial",
"title": "serial",
"_required_": true,
"type": "string"
},
"lunid": {
"_name_": "lunid",
"title": "lunid",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"transfermode": {
"_name_": "transfermode",
"title": "transfermode",
"_required_": true,
"type": "string"
},
"hddstandby": {
"_name_": "hddstandby",
"title": "hddstandby",
"_required_": true,
"type": "string",
"enum": [
"ALWAYS ON",
"5",
"10",
"20",
"30",
"60",
"120",
"180",
"240",
"300",
"330"
]
},
"togglesmart": {
"type": "boolean",
"_name_": "togglesmart",
"title": "togglesmart",
"_required_": true
},
"advpowermgmt": {
"_name_": "advpowermgmt",
"title": "advpowermgmt",
"_required_": true,
"type": "string",
"enum": [
"DISABLED",
"1",
"64",
"127",
"128",
"192",
"254"
]
},
"smartoptions": {
"_name_": "smartoptions",
"title": "smartoptions",
"_required_": true,
"type": "string"
},
"expiretime": {
"_name_": "expiretime",
"title": "expiretime",
"_required_": true,
"type": [
"string",
"null"
]
},
"critical": {
"type": [
"integer",
"null"
],
"_name_": "critical",
"title": "critical",
"_required_": true
},
"difference": {
"type": [
"integer",
"null"
],
"_name_": "difference",
"title": "difference",
"_required_": true
},
"informational": {
"type": [
"integer",
"null"
],
"_name_": "informational",
"title": "informational",
"_required_": true
},
"model": {
"_name_": "model",
"title": "model",
"_required_": true,
"type": [
"string",
"null"
]
},
"rotationrate": {
"type": [
"integer",
"null"
],
"_name_": "rotationrate",
"title": "rotationrate",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": [
"string",
"null"
]
},
"zfs_guid": {
"_name_": "zfs_guid",
"title": "zfs_guid",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"devname": {
"_name_": "devname",
"title": "devname",
"_required_": true,
"type": "string"
},
"enclosure": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": false
},
"slot": {
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "enclosure",
"title": "enclosure",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"slot"
]
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"passwd": {
"_name_": "passwd",
"title": "passwd",
"_required_": false,
"type": "string"
},
"kmip_uid": {
"_name_": "kmip_uid",
"title": "kmip_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"supports_smart": {
"type": [
"boolean",
"null"
],
"_name_": "supports_smart",
"title": "supports_smart",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "disk_entry",
"title": "disk_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"identifier",
"name",
"subsystem",
"number",
"serial",
"lunid",
"size",
"description",
"transfermode",
"hddstandby",
"togglesmart",
"advpowermgmt",
"smartoptions",
"expiretime",
"critical",
"difference",
"informational",
"model",
"rotationrate",
"type",
"zfs_guid",
"bus",
"devname",
"enclosure",
"pool",
"passwd",
"kmip_uid",
"supports_smart"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
disk.get_unused |
---|
Arguments:
{
"type": "boolean",
"_name_": "join_partitions",
"title": "join_partitions",
"default": false,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Return disks that are NOT in use by any zpool that is currently imported OR exported.
|
disk.get_used |
---|
Arguments:
{
"type": "boolean",
"_name_": "join_partitions",
"title": "join_partitions",
"default": false,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Return disks that are in use by any zpool that is currently imported. It will also return disks that are in use by any zpool that is exported.
|
disk.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"subsystem": {
"_name_": "subsystem",
"title": "subsystem",
"_required_": true,
"type": "string"
},
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"serial": {
"_name_": "serial",
"title": "serial",
"_required_": true,
"type": "string"
},
"lunid": {
"_name_": "lunid",
"title": "lunid",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"transfermode": {
"_name_": "transfermode",
"title": "transfermode",
"_required_": true,
"type": "string"
},
"hddstandby": {
"_name_": "hddstandby",
"title": "hddstandby",
"_required_": true,
"type": "string",
"enum": [
"ALWAYS ON",
"5",
"10",
"20",
"30",
"60",
"120",
"180",
"240",
"300",
"330"
]
},
"togglesmart": {
"type": "boolean",
"_name_": "togglesmart",
"title": "togglesmart",
"_required_": true
},
"advpowermgmt": {
"_name_": "advpowermgmt",
"title": "advpowermgmt",
"_required_": true,
"type": "string",
"enum": [
"DISABLED",
"1",
"64",
"127",
"128",
"192",
"254"
]
},
"smartoptions": {
"_name_": "smartoptions",
"title": "smartoptions",
"_required_": true,
"type": "string"
},
"expiretime": {
"_name_": "expiretime",
"title": "expiretime",
"_required_": true,
"type": [
"string",
"null"
]
},
"critical": {
"type": [
"integer",
"null"
],
"_name_": "critical",
"title": "critical",
"_required_": true
},
"difference": {
"type": [
"integer",
"null"
],
"_name_": "difference",
"title": "difference",
"_required_": true
},
"informational": {
"type": [
"integer",
"null"
],
"_name_": "informational",
"title": "informational",
"_required_": true
},
"model": {
"_name_": "model",
"title": "model",
"_required_": true,
"type": [
"string",
"null"
]
},
"rotationrate": {
"type": [
"integer",
"null"
],
"_name_": "rotationrate",
"title": "rotationrate",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": [
"string",
"null"
]
},
"zfs_guid": {
"_name_": "zfs_guid",
"title": "zfs_guid",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"devname": {
"_name_": "devname",
"title": "devname",
"_required_": true,
"type": "string"
},
"enclosure": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": false
},
"slot": {
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "enclosure",
"title": "enclosure",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"slot"
]
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"passwd": {
"_name_": "passwd",
"title": "passwd",
"_required_": false,
"type": "string"
},
"kmip_uid": {
"_name_": "kmip_uid",
"title": "kmip_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"supports_smart": {
"type": [
"boolean",
"null"
],
"_name_": "supports_smart",
"title": "supports_smart",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "disk_entry",
"title": "disk_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"identifier",
"name",
"subsystem",
"number",
"serial",
"lunid",
"size",
"description",
"transfermode",
"hddstandby",
"togglesmart",
"advpowermgmt",
"smartoptions",
"expiretime",
"critical",
"difference",
"informational",
"model",
"rotationrate",
"type",
"zfs_guid",
"bus",
"devname",
"enclosure",
"pool",
"passwd",
"kmip_uid",
"supports_smart"
]
}
]
},
{
"type": "object",
"properties": {
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"subsystem": {
"_name_": "subsystem",
"title": "subsystem",
"_required_": true,
"type": "string"
},
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"serial": {
"_name_": "serial",
"title": "serial",
"_required_": true,
"type": "string"
},
"lunid": {
"_name_": "lunid",
"title": "lunid",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"transfermode": {
"_name_": "transfermode",
"title": "transfermode",
"_required_": true,
"type": "string"
},
"hddstandby": {
"_name_": "hddstandby",
"title": "hddstandby",
"_required_": true,
"type": "string",
"enum": [
"ALWAYS ON",
"5",
"10",
"20",
"30",
"60",
"120",
"180",
"240",
"300",
"330"
]
},
"togglesmart": {
"type": "boolean",
"_name_": "togglesmart",
"title": "togglesmart",
"_required_": true
},
"advpowermgmt": {
"_name_": "advpowermgmt",
"title": "advpowermgmt",
"_required_": true,
"type": "string",
"enum": [
"DISABLED",
"1",
"64",
"127",
"128",
"192",
"254"
]
},
"smartoptions": {
"_name_": "smartoptions",
"title": "smartoptions",
"_required_": true,
"type": "string"
},
"expiretime": {
"_name_": "expiretime",
"title": "expiretime",
"_required_": true,
"type": [
"string",
"null"
]
},
"critical": {
"type": [
"integer",
"null"
],
"_name_": "critical",
"title": "critical",
"_required_": true
},
"difference": {
"type": [
"integer",
"null"
],
"_name_": "difference",
"title": "difference",
"_required_": true
},
"informational": {
"type": [
"integer",
"null"
],
"_name_": "informational",
"title": "informational",
"_required_": true
},
"model": {
"_name_": "model",
"title": "model",
"_required_": true,
"type": [
"string",
"null"
]
},
"rotationrate": {
"type": [
"integer",
"null"
],
"_name_": "rotationrate",
"title": "rotationrate",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": [
"string",
"null"
]
},
"zfs_guid": {
"_name_": "zfs_guid",
"title": "zfs_guid",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"devname": {
"_name_": "devname",
"title": "devname",
"_required_": true,
"type": "string"
},
"enclosure": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": false
},
"slot": {
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "enclosure",
"title": "enclosure",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"slot"
]
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"passwd": {
"_name_": "passwd",
"title": "passwd",
"_required_": false,
"type": "string"
},
"kmip_uid": {
"_name_": "kmip_uid",
"title": "kmip_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"supports_smart": {
"type": [
"boolean",
"null"
],
"_name_": "supports_smart",
"title": "supports_smart",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "disk_entry",
"title": "disk_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"identifier",
"name",
"subsystem",
"number",
"serial",
"lunid",
"size",
"description",
"transfermode",
"hddstandby",
"togglesmart",
"advpowermgmt",
"smartoptions",
"expiretime",
"critical",
"difference",
"informational",
"model",
"rotationrate",
"type",
"zfs_guid",
"bus",
"devname",
"enclosure",
"pool",
"passwd",
"kmip_uid",
"supports_smart"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"subsystem": {
"_name_": "subsystem",
"title": "subsystem",
"_required_": true,
"type": "string"
},
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"serial": {
"_name_": "serial",
"title": "serial",
"_required_": true,
"type": "string"
},
"lunid": {
"_name_": "lunid",
"title": "lunid",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"transfermode": {
"_name_": "transfermode",
"title": "transfermode",
"_required_": true,
"type": "string"
},
"hddstandby": {
"_name_": "hddstandby",
"title": "hddstandby",
"_required_": true,
"type": "string",
"enum": [
"ALWAYS ON",
"5",
"10",
"20",
"30",
"60",
"120",
"180",
"240",
"300",
"330"
]
},
"togglesmart": {
"type": "boolean",
"_name_": "togglesmart",
"title": "togglesmart",
"_required_": true
},
"advpowermgmt": {
"_name_": "advpowermgmt",
"title": "advpowermgmt",
"_required_": true,
"type": "string",
"enum": [
"DISABLED",
"1",
"64",
"127",
"128",
"192",
"254"
]
},
"smartoptions": {
"_name_": "smartoptions",
"title": "smartoptions",
"_required_": true,
"type": "string"
},
"expiretime": {
"_name_": "expiretime",
"title": "expiretime",
"_required_": true,
"type": [
"string",
"null"
]
},
"critical": {
"type": [
"integer",
"null"
],
"_name_": "critical",
"title": "critical",
"_required_": true
},
"difference": {
"type": [
"integer",
"null"
],
"_name_": "difference",
"title": "difference",
"_required_": true
},
"informational": {
"type": [
"integer",
"null"
],
"_name_": "informational",
"title": "informational",
"_required_": true
},
"model": {
"_name_": "model",
"title": "model",
"_required_": true,
"type": [
"string",
"null"
]
},
"rotationrate": {
"type": [
"integer",
"null"
],
"_name_": "rotationrate",
"title": "rotationrate",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": [
"string",
"null"
]
},
"zfs_guid": {
"_name_": "zfs_guid",
"title": "zfs_guid",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"devname": {
"_name_": "devname",
"title": "devname",
"_required_": true,
"type": "string"
},
"enclosure": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": false
},
"slot": {
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "enclosure",
"title": "enclosure",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"slot"
]
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"passwd": {
"_name_": "passwd",
"title": "passwd",
"_required_": false,
"type": "string"
},
"kmip_uid": {
"_name_": "kmip_uid",
"title": "kmip_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"supports_smart": {
"type": [
"boolean",
"null"
],
"_name_": "supports_smart",
"title": "supports_smart",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "disk_entry",
"title": "disk_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"identifier",
"name",
"subsystem",
"number",
"serial",
"lunid",
"size",
"description",
"transfermode",
"hddstandby",
"togglesmart",
"advpowermgmt",
"smartoptions",
"expiretime",
"critical",
"difference",
"informational",
"model",
"rotationrate",
"type",
"zfs_guid",
"bus",
"devname",
"enclosure",
"pool",
"passwd",
"kmip_uid",
"supports_smart"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Query disks. The following extra options are supported:
|
disk.resize
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"size"
]
}
]
}
{
"type": "boolean",
"_name_": "sync",
"title": "sync",
"default": true,
"_required_": false,
"description": "`sync`: boolean, when true (default) will synchronize the new size of the disk(s)\n with the database cache."
}
{
"type": "boolean",
"_name_": "raise_error",
"title": "raise_error",
"default": false,
"_required_": false,
"description": "`raise_error`: boolean\n when true, will raise a `CallError` if any failures occur\n when false, will will log the errors if any failures occur"
}
|
Takes a list of disks. Each list entry is a dict that requires a key, value pair.
NOTE:
if |
disk.retaste
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "disks",
"title": "disks",
"default": null,
"_required_": false,
"type": "array",
"items": [
{
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
}
]
}
|
- |
disk.smart_attributes |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "smart_attributes",
"title": "smart_attributes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"value": {
"type": "integer",
"_name_": "value",
"title": "value",
"_required_": true
},
"worst": {
"type": "integer",
"_name_": "worst",
"title": "worst",
"_required_": true
},
"thresh": {
"type": "integer",
"_name_": "thresh",
"title": "thresh",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"when_failed": {
"_name_": "when_failed",
"title": "when_failed",
"_required_": true,
"type": "string"
},
"flags": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"_name_": "value",
"title": "value",
"_required_": true
},
"string": {
"_name_": "string",
"title": "string",
"_required_": true,
"type": "string"
},
"prefailure": {
"type": "boolean",
"_name_": "prefailure",
"title": "prefailure",
"_required_": true
},
"updated_online": {
"type": "boolean",
"_name_": "updated_online",
"title": "updated_online",
"_required_": true
},
"performance": {
"type": "boolean",
"_name_": "performance",
"title": "performance",
"_required_": true
},
"error_rate": {
"type": "boolean",
"_name_": "error_rate",
"title": "error_rate",
"_required_": true
},
"event_count": {
"type": "boolean",
"_name_": "event_count",
"title": "event_count",
"_required_": true
},
"auto_keep": {
"type": "boolean",
"_name_": "auto_keep",
"title": "auto_keep",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"value",
"string",
"prefailure",
"updated_online",
"performance",
"error_rate",
"event_count",
"auto_keep"
]
},
"raw": {
"type": "object",
"properties": {
"value": {
"type": "integer",
"_name_": "value",
"title": "value",
"_required_": true
},
"string": {
"_name_": "string",
"title": "string",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "raw",
"title": "raw",
"default": {},
"_required_": false,
"_attrs_order_": [
"value",
"string"
]
}
},
"additionalProperties": false,
"_name_": "smart_attribute",
"title": "smart_attribute",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"value",
"worst",
"thresh",
"name",
"when_failed",
"flags",
"raw"
]
}
]
}
|
Returns S.M.A.R.T. attributes values for specified disk name. |
disk.temperature |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"cache": {
"type": [
"integer",
"null"
],
"_name_": "cache",
"title": "cache",
"default": null,
"_required_": false
},
"powermode": {
"_name_": "powermode",
"title": "powermode",
"default": "NEVER",
"_required_": false,
"type": "string",
"enum": [
"NEVER",
"SLEEP",
"STANDBY",
"IDLE"
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"cache",
"powermode"
]
}
|
Return Arguments:
{
"type": [
"integer",
"null"
],
"_name_": "temperature",
"title": "temperature",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Returns temperature for device |
disk.temperature_agg |
---|
Arguments:
{
"_name_": "names",
"title": "names",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
]
}
{
"type": "integer",
"_name_": "days",
"title": "days",
"default": 7,
"_required_": false
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "temperatures",
"title": "temperatures",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Returns min/max/avg temperature for |
disk.temperature_alerts |
---|
Arguments:
{
"_name_": "names",
"title": "names",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"uuid": {
"_name_": "uuid",
"title": "uuid",
"_required_": false,
"type": "string"
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"klass": {
"_name_": "klass",
"title": "klass",
"_required_": false,
"type": "string"
},
"args": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "args",
"title": "args",
"_required_": false
},
"node": {
"_name_": "node",
"title": "node",
"_required_": false,
"type": "string"
},
"key": {
"_name_": "key",
"title": "key",
"_required_": false,
"type": "string"
},
"datetime": {
"_name_": "datetime",
"title": "datetime",
"_required_": false,
"type": "string"
},
"last_occurrence": {
"_name_": "last_occurrence",
"title": "last_occurrence",
"_required_": false,
"type": "string"
},
"dismissed": {
"type": "boolean",
"_name_": "dismissed",
"title": "dismissed",
"_required_": false
},
"mail": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "mail",
"title": "mail",
"_required_": false
},
"text": {
"_name_": "text",
"title": "text",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"level": {
"_name_": "level",
"title": "level",
"_required_": false,
"type": "string"
},
"formatted": {
"_name_": "formatted",
"title": "formatted",
"_required_": false,
"type": [
"string",
"null"
]
},
"one_shot": {
"type": "boolean",
"_name_": "one_shot",
"title": "one_shot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "alert",
"title": "alert",
"default": {},
"_required_": false,
"_attrs_order_": [
"uuid",
"source",
"klass",
"args",
"node",
"key",
"datetime",
"last_occurrence",
"dismissed",
"mail",
"text",
"id",
"level",
"formatted",
"one_shot"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Returns existing temperature alerts for specified disk |
disk.temperatures |
---|
Arguments:
{
"_name_": "names",
"title": "names",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
]
}
{
"type": "object",
"properties": {
"cache": {
"type": [
"integer",
"null"
],
"_name_": "cache",
"title": "cache",
"default": 290,
"_required_": false
},
"only_cached": {
"type": "boolean",
"_name_": "only_cached",
"title": "only_cached",
"default": false,
"_required_": false
},
"powermode": {
"_name_": "powermode",
"title": "powermode",
"default": "NEVER",
"_required_": false,
"type": "string",
"enum": [
"NEVER",
"SLEEP",
"STANDBY",
"IDLE"
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"cache",
"only_cached",
"powermode"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "disks_temperatures",
"title": "disks_temperatures",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Returns temperatures for a list of devices (runs in parallel).
See |
disk.update |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Update disk of `id`."
}
{
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"lunid": {
"_name_": "lunid",
"title": "lunid",
"_required_": true,
"type": [
"string",
"null"
]
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"hddstandby": {
"_name_": "hddstandby",
"title": "hddstandby",
"_required_": true,
"type": "string",
"enum": [
"ALWAYS ON",
"5",
"10",
"20",
"30",
"60",
"120",
"180",
"240",
"300",
"330"
]
},
"togglesmart": {
"type": "boolean",
"_name_": "togglesmart",
"title": "togglesmart",
"_required_": true
},
"advpowermgmt": {
"_name_": "advpowermgmt",
"title": "advpowermgmt",
"_required_": true,
"type": "string",
"enum": [
"DISABLED",
"1",
"64",
"127",
"128",
"192",
"254"
]
},
"smartoptions": {
"_name_": "smartoptions",
"title": "smartoptions",
"_required_": true,
"type": "string",
"description": "`smartoptions`."
},
"critical": {
"type": [
"integer",
"null"
],
"_name_": "critical",
"title": "critical",
"_required_": true,
"description": "`critical`, `informational` and `difference` are integer values on which alerts for SMART are configured\nif the disk temperature crosses the assigned threshold for each respective attribute.\nIf they are set to null, then SMARTD config values are used as defaults.\nEmail of log level LOG_CRIT is issued when disk temperature crosses `critical`."
},
"difference": {
"type": [
"integer",
"null"
],
"_name_": "difference",
"title": "difference",
"_required_": true,
"description": "`critical`, `informational` and `difference` are integer values on which alerts for SMART are configured\nif the disk temperature crosses the assigned threshold for each respective attribute.\nIf they are set to null, then SMARTD config values are used as defaults."
},
"informational": {
"type": [
"integer",
"null"
],
"_name_": "informational",
"title": "informational",
"_required_": true,
"description": "`critical`, `informational` and `difference` are integer values on which alerts for SMART are configured\nif the disk temperature crosses the assigned threshold for each respective attribute.\nIf they are set to null, then SMARTD config values are used as defaults.\nEmail of log level LOG_INFO is issued when disk temperature crosses `informational`."
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"enclosure": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": false
},
"slot": {
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "enclosure",
"title": "enclosure",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"slot"
]
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"passwd": {
"_name_": "passwd",
"title": "passwd",
"_required_": false,
"type": "string"
},
"supports_smart": {
"type": [
"boolean",
"null"
],
"_name_": "supports_smart",
"title": "supports_smart",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "disk_update",
"title": "disk_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"number",
"lunid",
"description",
"hddstandby",
"togglesmart",
"advpowermgmt",
"smartoptions",
"critical",
"difference",
"informational",
"bus",
"enclosure",
"pool",
"passwd",
"supports_smart"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"subsystem": {
"_name_": "subsystem",
"title": "subsystem",
"_required_": true,
"type": "string"
},
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"serial": {
"_name_": "serial",
"title": "serial",
"_required_": true,
"type": "string"
},
"lunid": {
"_name_": "lunid",
"title": "lunid",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"transfermode": {
"_name_": "transfermode",
"title": "transfermode",
"_required_": true,
"type": "string"
},
"hddstandby": {
"_name_": "hddstandby",
"title": "hddstandby",
"_required_": true,
"type": "string",
"enum": [
"ALWAYS ON",
"5",
"10",
"20",
"30",
"60",
"120",
"180",
"240",
"300",
"330"
]
},
"togglesmart": {
"type": "boolean",
"_name_": "togglesmart",
"title": "togglesmart",
"_required_": true
},
"advpowermgmt": {
"_name_": "advpowermgmt",
"title": "advpowermgmt",
"_required_": true,
"type": "string",
"enum": [
"DISABLED",
"1",
"64",
"127",
"128",
"192",
"254"
]
},
"smartoptions": {
"_name_": "smartoptions",
"title": "smartoptions",
"_required_": true,
"type": "string",
"description": "`smartoptions`."
},
"expiretime": {
"_name_": "expiretime",
"title": "expiretime",
"_required_": true,
"type": [
"string",
"null"
]
},
"critical": {
"type": [
"integer",
"null"
],
"_name_": "critical",
"title": "critical",
"_required_": true,
"description": "`critical`, `informational` and `difference` are integer values on which alerts for SMART are configured\nif the disk temperature crosses the assigned threshold for each respective attribute.\nIf they are set to null, then SMARTD config values are used as defaults.\nEmail of log level LOG_CRIT is issued when disk temperature crosses `critical`."
},
"difference": {
"type": [
"integer",
"null"
],
"_name_": "difference",
"title": "difference",
"_required_": true,
"description": "`critical`, `informational` and `difference` are integer values on which alerts for SMART are configured\nif the disk temperature crosses the assigned threshold for each respective attribute.\nIf they are set to null, then SMARTD config values are used as defaults."
},
"informational": {
"type": [
"integer",
"null"
],
"_name_": "informational",
"title": "informational",
"_required_": true,
"description": "`critical`, `informational` and `difference` are integer values on which alerts for SMART are configured\nif the disk temperature crosses the assigned threshold for each respective attribute.\nIf they are set to null, then SMARTD config values are used as defaults.\nEmail of log level LOG_INFO is issued when disk temperature crosses `informational`."
},
"model": {
"_name_": "model",
"title": "model",
"_required_": true,
"type": [
"string",
"null"
]
},
"rotationrate": {
"type": [
"integer",
"null"
],
"_name_": "rotationrate",
"title": "rotationrate",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": [
"string",
"null"
]
},
"zfs_guid": {
"_name_": "zfs_guid",
"title": "zfs_guid",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"devname": {
"_name_": "devname",
"title": "devname",
"_required_": true,
"type": "string"
},
"enclosure": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": false
},
"slot": {
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "enclosure",
"title": "enclosure",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"slot"
]
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"passwd": {
"_name_": "passwd",
"title": "passwd",
"_required_": false,
"type": "string"
},
"kmip_uid": {
"_name_": "kmip_uid",
"title": "kmip_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"supports_smart": {
"type": [
"boolean",
"null"
],
"_name_": "supports_smart",
"title": "supports_smart",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "disk_update_returns",
"title": "disk_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"identifier",
"name",
"subsystem",
"number",
"serial",
"lunid",
"size",
"description",
"transfermode",
"hddstandby",
"togglesmart",
"advpowermgmt",
"smartoptions",
"expiretime",
"critical",
"difference",
"informational",
"model",
"rotationrate",
"type",
"zfs_guid",
"bus",
"devname",
"enclosure",
"pool",
"passwd",
"kmip_uid",
"supports_smart"
]
}
|
Update disk of If extra options need to be passed to SMART which we don't already support, they can be passed by
Email of log level LOG_CRIT is issued when disk temperature crosses Email of log level LOG_INFO is issued when disk temperature crosses If temperature of a disk changes by |
disk.wipe
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "dev",
"title": "dev",
"_required_": false,
"type": "string"
}
{
"_name_": "mode",
"title": "mode",
"_required_": true,
"type": "string",
"enum": [
"QUICK",
"FULL",
"FULL_RANDOM"
]
}
{
"type": "boolean",
"_name_": "synccache",
"title": "synccache",
"default": true,
"_required_": false
}
|
Performs a wipe of a disk |
dns.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"nameserver": {
"_name_": "nameserver",
"title": "nameserver",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "nameserver",
"title": "nameserver",
"default": {},
"_required_": false,
"_attrs_order_": [
"nameserver"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"nameserver": {
"_name_": "nameserver",
"title": "nameserver",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "nameserver",
"title": "nameserver",
"default": {},
"_required_": false,
"_attrs_order_": [
"nameserver"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Query Name Servers with |
docker.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"enable_image_updates": {
"type": "boolean",
"_name_": "enable_image_updates",
"title": "enable_image_updates",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"dataset": {
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string"
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"nvidia": {
"type": "boolean",
"_name_": "nvidia",
"title": "nvidia",
"_required_": true
},
"address_pools": {
"_name_": "address_pools",
"title": "address_pools",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"base": {
"_name_": "base",
"title": "base",
"_required_": false,
"type": "string"
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "address_pool",
"title": "address_pool",
"default": {},
"_required_": false,
"_attrs_order_": [
"base",
"size"
]
}
]
}
},
"additionalProperties": false,
"_name_": "docker_entry",
"title": "docker_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable_image_updates",
"id",
"dataset",
"pool",
"nvidia",
"address_pools"
]
}
|
This method is accessible to the users granted with the following roles: DOCKER_READ, DOCKER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
docker.lacks_nvidia_drivers |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "lacks_nvidia_drivers",
"title": "lacks_nvidia_drivers",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DOCKER_READ, DOCKER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns true if an NVIDIA GPU is present, but NVIDIA drivers are not installed. |
docker.status |
---|
Return Arguments:
{
"type": "object",
"properties": {
"status": {
"_name_": "status",
"title": "status",
"_required_": false,
"type": "string",
"enum": [
"PENDING",
"RUNNING",
"INITIALIZING",
"STOPPING",
"STOPPED",
"UNCONFIGURED",
"FAILED"
]
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"status",
"description"
]
}
|
This method is accessible to the users granted with the following roles: DOCKER_READ, DOCKER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns the status of the docker service. |
docker.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"enable_image_updates": {
"type": "boolean",
"_name_": "enable_image_updates",
"title": "enable_image_updates",
"_required_": true
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"nvidia": {
"type": "boolean",
"_name_": "nvidia",
"title": "nvidia",
"_required_": true
},
"address_pools": {
"_name_": "address_pools",
"title": "address_pools",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"base": {
"_name_": "base",
"title": "base",
"_required_": false,
"type": "string"
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "address_pool",
"title": "address_pool",
"default": {},
"_required_": false,
"_attrs_order_": [
"base",
"size"
]
}
]
}
},
"additionalProperties": false,
"_name_": "docker_update",
"title": "docker_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable_image_updates",
"pool",
"nvidia",
"address_pools"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enable_image_updates": {
"type": "boolean",
"_name_": "enable_image_updates",
"title": "enable_image_updates",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"dataset": {
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string"
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": [
"string",
"null"
]
},
"nvidia": {
"type": "boolean",
"_name_": "nvidia",
"title": "nvidia",
"_required_": true
},
"address_pools": {
"_name_": "address_pools",
"title": "address_pools",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"base": {
"_name_": "base",
"title": "base",
"_required_": false,
"type": "string"
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "address_pool",
"title": "address_pool",
"default": {},
"_required_": false,
"_attrs_order_": [
"base",
"size"
]
}
]
}
},
"additionalProperties": false,
"_name_": "docker_update_returns",
"title": "docker_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable_image_updates",
"id",
"dataset",
"pool",
"nvidia",
"address_pools"
]
}
|
This method is accessible to the users granted with the following roles: DOCKER_WRITE |
Update Docker service configuration. |
docker.network.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"ipam": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipam",
"title": "ipam",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"labels": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "labels",
"title": "labels",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"created": {
"_name_": "created",
"title": "created",
"_required_": true,
"type": [
"string",
"null"
]
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": [
"string",
"null"
]
},
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": [
"string",
"null"
],
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": [
"string",
"null"
]
},
"scope": {
"_name_": "scope",
"title": "scope",
"_required_": true,
"type": [
"string",
"null"
]
},
"short_id": {
"_name_": "short_id",
"title": "short_id",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": true,
"_name_": "docker_network_entry",
"title": "docker_network_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipam",
"labels",
"created",
"driver",
"id",
"name",
"scope",
"short_id"
]
}
|
This method is accessible to the users granted with the following roles: DOCKER_READ, DOCKER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
docker.network.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ipam": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipam",
"title": "ipam",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"labels": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "labels",
"title": "labels",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"created": {
"_name_": "created",
"title": "created",
"_required_": true,
"type": [
"string",
"null"
]
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": [
"string",
"null"
]
},
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": [
"string",
"null"
]
},
"scope": {
"_name_": "scope",
"title": "scope",
"_required_": true,
"type": [
"string",
"null"
]
},
"short_id": {
"_name_": "short_id",
"title": "short_id",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": true,
"_name_": "docker_network_entry",
"title": "docker_network_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipam",
"labels",
"created",
"driver",
"id",
"name",
"scope",
"short_id"
]
}
]
},
{
"type": "object",
"properties": {
"ipam": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipam",
"title": "ipam",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"labels": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "labels",
"title": "labels",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"created": {
"_name_": "created",
"title": "created",
"_required_": true,
"type": [
"string",
"null"
]
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": [
"string",
"null"
]
},
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": [
"string",
"null"
]
},
"scope": {
"_name_": "scope",
"title": "scope",
"_required_": true,
"type": [
"string",
"null"
]
},
"short_id": {
"_name_": "short_id",
"title": "short_id",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": true,
"_name_": "docker_network_entry",
"title": "docker_network_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipam",
"labels",
"created",
"driver",
"id",
"name",
"scope",
"short_id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"ipam": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipam",
"title": "ipam",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"labels": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "labels",
"title": "labels",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"created": {
"_name_": "created",
"title": "created",
"_required_": true,
"type": [
"string",
"null"
]
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": [
"string",
"null"
]
},
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": [
"string",
"null"
]
},
"scope": {
"_name_": "scope",
"title": "scope",
"_required_": true,
"type": [
"string",
"null"
]
},
"short_id": {
"_name_": "short_id",
"title": "short_id",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": true,
"_name_": "docker_network_entry",
"title": "docker_network_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipam",
"labels",
"created",
"driver",
"id",
"name",
"scope",
"short_id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DOCKER_READ, DOCKER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query all docker networks |
enclosure.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "enclosure_entry",
"title": "enclosure_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
enclosure.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "enclosure_entry",
"title": "enclosure_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "enclosure_entry",
"title": "enclosure_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "enclosure_entry",
"title": "enclosure_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
enclosure.set_slot_status |
---|
Arguments:
{
"_name_": "enclosure_id",
"title": "enclosure_id",
"_required_": false,
"type": "string"
}
{
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
}
{
"_name_": "status",
"title": "status",
"_required_": false,
"type": "string",
"enum": [
"CLEAR",
"FAULT",
"IDENTIFY"
]
}
|
- |
enclosure.update |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"label": {
"_name_": "label",
"title": "label",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "enclosure_update",
"title": "enclosure_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"label"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "enclosure_update_returns",
"title": "enclosure_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
- |
failover.become_passive |
---|
This method is only called manually by the end-user so we fully expect that they know what they're doing. Furthermore, this method will only run if failover has NOT been administratively disabled. The reason why we only allow this in that scenario is because the failover logic (on the other node) will ignore any failover "event" that comes in if failover has been administratively disabled. This immediately causes the HA system to go into a "faulted" state because the other node will get the VIPs but it will not import the zpool and it will not start fenced. Only way out of that situation is to manually fix things (import zpool, migrate VIPs, start fenced, etc). NOTE: The only "safe" way to "become passive" is to use the STCNITH method (similar to STONITH). (i.e. Shoot The Current Node In The Head) This ensures that the current node gets out of the way completely so there is no chance of the zpool being imported at the same time on both nodes (which can ultimately end in data corruption). |
failover.call_remote |
---|
Arguments:
{
"_name_": "method",
"title": "method",
"_required_": false,
"type": "string",
"description": "`method` name of the method to be called\n`args` list of arguments to be passed to `method`"
}
{
"_name_": "args",
"title": "args",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`method` name of the method to be called\n`args` list of arguments to be passed to `method`"
}
{
"type": "object",
"properties": {
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 60,
"_required_": false
},
"job": {
"type": "boolean",
"_name_": "job",
"title": "job",
"default": false,
"_required_": false
},
"job_return": {
"type": [
"boolean",
"null"
],
"_name_": "job_return",
"title": "job_return",
"default": null,
"_required_": false
},
"callback": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "callback",
"title": "callback",
"default": null,
"_required_": false
},
"connect_timeout": {
"type": "float",
"_name_": "connect_timeout",
"title": "connect_timeout",
"default": 2.0,
"_required_": false
},
"raise_connect_error": {
"type": "boolean",
"_name_": "raise_connect_error",
"title": "raise_connect_error",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"timeout",
"job",
"job_return",
"callback",
"connect_timeout",
"raise_connect_error"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "call_remote",
"title": "call_remote",
"_required_": false
}
|
Call a method on the other node.
|
failover.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"disabled": {
"type": "boolean",
"_name_": "disabled",
"title": "disabled",
"_required_": true
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"_required_": true
},
"master": {
"type": "boolean",
"_name_": "master",
"title": "master",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "failover_entry",
"title": "failover_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"disabled",
"timeout",
"master"
]
}
|
This method is accessible to the users granted with the following roles: FAILOVER_READ, FAILOVER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
failover.control |
---|
Arguments:
{
"_name_": "action",
"title": "action",
"_required_": false,
"type": "string",
"enum": [
"ENABLE",
"DISABLE"
]
}
{
"type": "object",
"properties": {
"active": {
"type": "boolean",
"_name_": "active",
"title": "active",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"active"
]
}
|
This method is accessible to the users granted with the following roles: FAILOVER_WRITE |
- |
failover.force_master |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "force_master",
"title": "force_master",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FAILOVER_WRITE |
Force this controller to become MASTER, if it's not already. |
failover.get_ips |
---|
Return Arguments:
{
"_name_": "ips",
"title": "ips",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
]
}
|
Get a list of IPs for which the webUI can be accessed. |
failover.hardware |
---|
Return Arguments:
{
"_name_": "hardware",
"title": "hardware",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: FAILOVER_READ, FAILOVER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns the hardware type for an HA system. ECHOSTREAM (z-series) ECHOWARP (m-series) LAJOLLA2 (f-series) SUBLIGHT (h-series) PUMA (x-series) BHYVE (HA VMs for CI) IXKVM (HA VMs (on KVM) for CI) MANUAL (everything else) |
failover.in_progress |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "in_progress",
"title": "in_progress",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FAILOVER_READ, FAILOVER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns True if there is an ongoing failover event. |
failover.licensed |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "licensed",
"title": "licensed",
"_required_": false
}
|
Checks whether this instance is licensed as a HA unit |
failover.node |
---|
Return Arguments:
{
"_name_": "node",
"title": "node",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: FAILOVER_READ, FAILOVER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns the slot position in the chassis that the controller is located. A - First node B - Seconde Node MANUAL - slot position in chassis could not be determined |
failover.status |
---|
Return Arguments:
{
"_name_": "status",
"title": "status",
"_required_": false,
"type": "string"
}
|
Get the current HA status. Returns: MASTER BACKUP ELECTING IMPORTING ERROR SINGLE |
failover.sync_from_peer |
---|
This method is accessible to the users granted with the following roles: FAILOVER_WRITE |
Sync database and files from the other controller. |
failover.sync_to_peer |
---|
Arguments:
{
"type": "object",
"properties": {
"reboot": {
"type": "boolean",
"_name_": "reboot",
"title": "reboot",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"reboot"
]
}
|
This method is accessible to the users granted with the following roles: FAILOVER_WRITE |
Sync database and files to the other controller.
|
failover.unlock |
---|
Arguments:
{
"type": "object",
"properties": {
"pools": {
"_name_": "pools",
"title": "pools",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_keys",
"title": "pool_keys",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"passphrase"
]
}
]
},
"datasets": {
"_name_": "datasets",
"title": "datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "dataset_keys",
"title": "dataset_keys",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"passphrase"
]
}
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"pools",
"datasets"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "unlock",
"title": "unlock",
"_required_": false
}
|
Unlock datasets in HA, syncing passphrase between controllers and forcing this controller to be MASTER importing the pools. |
failover.update |
---|
Arguments:
{
"type": "object",
"properties": {
"disabled": {
"type": "boolean",
"_name_": "disabled",
"title": "disabled",
"_required_": true,
"description": "`disabled` When true indicates that HA will be disabled."
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"_required_": true,
"description": "`timeout` is the time to WAIT until a failover occurs when a network\n event occurs on an interface that is marked critical for failover AND\n HA is enabled and working appropriately."
},
"master": {
"type": [
"boolean",
"null"
],
"_name_": "master",
"title": "master",
"_required_": true,
"description": "`master` Marks the particular node in the chassis as the master node.\n The standby node will have the opposite value."
}
},
"additionalProperties": false,
"_name_": "failover_update",
"title": "failover_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"disabled",
"timeout",
"master"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"disabled": {
"type": "boolean",
"_name_": "disabled",
"title": "disabled",
"_required_": true,
"description": "`disabled` When true indicates that HA will be disabled."
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"_required_": true,
"description": "`timeout` is the time to WAIT until a failover occurs when a network\n event occurs on an interface that is marked critical for failover AND\n HA is enabled and working appropriately."
},
"master": {
"type": "boolean",
"_name_": "master",
"title": "master",
"_required_": true,
"description": "`master` Marks the particular node in the chassis as the master node.\n The standby node will have the opposite value."
}
},
"additionalProperties": false,
"_name_": "failover_update_returns",
"title": "failover_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"disabled",
"timeout",
"master"
]
}
|
This method is accessible to the users granted with the following roles: FAILOVER_WRITE |
Update failover state.
|
failover.upgrade |
---|
Arguments:
{
"type": "object",
"properties": {
"train": {
"_name_": "train",
"title": "train",
"_required_": false,
"type": "string"
},
"resume": {
"type": "boolean",
"_name_": "resume",
"title": "resume",
"default": false,
"_required_": false
},
"resume_manual": {
"type": "boolean",
"_name_": "resume_manual",
"title": "resume_manual",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "failover_upgrade",
"title": "failover_upgrade",
"default": {},
"_required_": false,
"_attrs_order_": [
"train",
"resume",
"resume_manual"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "upgrade",
"title": "upgrade",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FAILOVER_WRITE |
Upgrades both controllers. Files will be downloaded to the Active Controller and then transferred to the Standby Controller. Upgrade process will start concurrently on both nodes. Once both upgrades are applied, the Standby Controller will reboot. This job will wait for that job to complete before finalizing.
|
failover.upgrade_finish
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Return Arguments:
{
"type": "boolean",
"_name_": "upgrade_finish",
"title": "upgrade_finish",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FAILOVER_WRITE |
Perform the last stage of an HA upgrade. This will activate the new boot environment on the Standby Controller and reboot it. |
failover.upgrade_pending |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "upgrade_pending",
"title": "upgrade_pending",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FAILOVER_READ, FAILOVER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Verify if HA upgrade is pending.
|
failover.disabled.reasons |
---|
Return Arguments:
{
"_name_": "reasons",
"title": "reasons",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "reason",
"title": "reason",
"_required_": false,
"type": "string"
}
]
}
|
Returns a list of reasons why failover is not enabled/functional.
See |
failover.reboot.info |
---|
Return Arguments:
{
"type": "object",
"properties": {
"this_node": {
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"reboot_required": {
"type": "boolean",
"_name_": "reboot_required",
"title": "reboot_required",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "this_node",
"title": "this_node",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"reboot_required"
]
},
"other_node": {
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": [
"string",
"null"
]
},
"reboot_required": {
"type": [
"boolean",
"null"
],
"_name_": "reboot_required",
"title": "reboot_required",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "other_node",
"title": "other_node",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"reboot_required"
]
}
},
"additionalProperties": false,
"_name_": "info",
"title": "info",
"default": {},
"_required_": false,
"_attrs_order_": [
"this_node",
"other_node"
]
}
|
This method is accessible to the users granted with the following roles: FAILOVER_READ, FAILOVER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns the local and remote nodes boot_ids along with their reboot statuses (i.e. does a reboot need to take place) |
failover.reboot.other_node
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
This method is accessible to the users granted with the following roles: FULL_ADMIN |
Reboot the other node and wait for it to come back online. NOTE: This makes very few checks on HA systems. You need to know what you're doing before calling this. |
failover.reboot.required |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "required",
"title": "required",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FAILOVER_READ, FAILOVER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns whether this node needs to be rebooted for failover/security system configuration changes to take effect. |
filesystem.acl_is_trivial |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "paths_acl_is_trivial",
"title": "paths_acl_is_trivial",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Returns True if the ACL can be fully expressed as a file mode without losing any access rules. |
filesystem.can_access_as_user |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"read": {
"type": [
"boolean",
"null"
],
"_name_": "read",
"title": "read",
"default": null,
"_required_": false
},
"write": {
"type": [
"boolean",
"null"
],
"_name_": "write",
"title": "write",
"default": null,
"_required_": false
},
"execute": {
"type": [
"boolean",
"null"
],
"_name_": "execute",
"title": "execute",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "permissions",
"title": "permissions",
"default": {},
"_required_": false,
"_attrs_order_": [
"read",
"write",
"execute"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "can_access_as_user",
"title": "can_access_as_user",
"_required_": false
}
|
Check if |
filesystem.chown
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "Change owner or group of file at `path`."
},
"uid": {
"type": [
"integer",
"null"
],
"_name_": "uid",
"title": "uid",
"default": null,
"_required_": false,
"description": "`uid` and `gid` specify new owner of the file. If either\nkey is absent or None, then existing value on the file is not\nchanged."
},
"gid": {
"type": [
"integer",
"null"
],
"_name_": "gid",
"title": "gid",
"default": null,
"_required_": false,
"description": "`uid` and `gid` specify new owner of the file. If either\nkey is absent or None, then existing value on the file is not\nchanged."
},
"options": {
"type": "object",
"properties": {
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
},
"traverse": {
"type": "boolean",
"_name_": "traverse",
"title": "traverse",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"recursive",
"traverse"
]
}
},
"additionalProperties": false,
"_name_": "filesystem_ownership",
"title": "filesystem_ownership",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"uid",
"gid",
"options"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, SHARING_ADMIN |
Change owner or group of file at
If |
filesystem.default_acl_choices |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"default": "",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "acl_choices",
"title": "acl_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "choice",
"title": "choice",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
|
filesystem.get |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
|
Job to get contents of |
filesystem.get_default_acl |
---|
Arguments:
{
"_name_": "acl_type",
"title": "acl_type",
"default": "POSIX_OPEN",
"_required_": false,
"type": "string"
}
{
"_name_": "share_type",
"title": "share_type",
"default": "NONE",
"_required_": false,
"type": "string",
"enum": [
"NONE",
"SMB",
"NFS"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
}
|
|
filesystem.get_zfs_attributes |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"_required_": false
},
"hidden": {
"type": "boolean",
"_name_": "hidden",
"title": "hidden",
"_required_": false
},
"system": {
"type": "boolean",
"_name_": "system",
"title": "system",
"_required_": false
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false
},
"immutable": {
"type": "boolean",
"_name_": "immutable",
"title": "immutable",
"_required_": false
},
"nounlink": {
"type": "boolean",
"_name_": "nounlink",
"title": "nounlink",
"_required_": false
},
"appendonly": {
"type": "boolean",
"_name_": "appendonly",
"title": "appendonly",
"_required_": false
},
"offline": {
"type": "boolean",
"_name_": "offline",
"title": "offline",
"_required_": false
},
"sparse": {
"type": "boolean",
"_name_": "sparse",
"title": "sparse",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "zfs_file_attributes",
"title": "zfs_file_attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"readonly",
"hidden",
"system",
"archive",
"immutable",
"nounlink",
"appendonly",
"offline",
"sparse"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Get the current ZFS attributes for the file at the given path |
filesystem.getacl |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
{
"type": "boolean",
"_name_": "simplified",
"title": "simplified",
"default": true,
"_required_": false,
"description": "`simplified` - effect of this depends on ACL type on underlying filesystem. In the case of\nNFSv4 ACLs simplified permissions and flags are returned for ACL entries where applicable.\nNFSv4 errata below. In the case of POSIX1E ACls, this setting has no impact on returned ACL.\n`simplified` returns a shortened form of the ACL permset and flags where applicable. If permissions\nhave been simplified, then the `perms` object will contain only a single `BASIC` key with a string\ndescribing the underlying permissions set."
}
{
"type": "boolean",
"_name_": "resolve_ids",
"title": "resolve_ids",
"default": false,
"_required_": false,
"description": "`resolve_ids` - adds additional `who` key to each ACL entry, that converts the numeric id to\na user name or group name. In the case of owner@ and group@ (NFSv4) or USER_OBJ and GROUP_OBJ\n(POSIX1E), st_uid or st_gid will be converted from stat() return for file. In the case of\nMASK (POSIX1E), OTHER (POSIX1E), everyone@ (NFSv4), key `who` will be included, but set to null.\nIn case of failure to resolve the id to a name, `who` will be set to null. This option should\nonly be used if resolving ids to names is required."
}
|
Return Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"trivial": {
"type": "boolean",
"_name_": "trivial",
"title": "trivial",
"_required_": false
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"NFS4",
"POSIX1E",
"DISABLED"
],
"description": "Return ACL of a given path. This may return a POSIX1e ACL or a NFSv4 ACL. The acl type is indicated\nby the `acltype` key."
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "truenas_acl",
"title": "truenas_acl",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"trivial",
"acltype",
"acl"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Return ACL of a given path. This may return a POSIX1e ACL or a NFSv4 ACL. The acl type is indicated
by the
Errata about ACLType NFSv4:
If the permisssions do not fit within one of the pre-defined simplified permissions types, then the full ACL entry will be returned. |
filesystem.is_immutable |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "is_immutable",
"title": "is_immutable",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Retrieves boolean which is set when immutable flag is set on |
filesystem.listdir |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"realpath": {
"_name_": "realpath",
"title": "realpath",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"DIRECTORY",
"FILE",
"SYMLINK",
"OTHER"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocation_size": {
"type": [
"integer",
"null"
],
"_name_": "allocation_size",
"title": "allocation_size",
"_required_": true
},
"mode": {
"type": [
"integer",
"null"
],
"_name_": "mode",
"title": "mode",
"_required_": true
},
"mount_id": {
"type": [
"integer",
"null"
],
"_name_": "mount_id",
"title": "mount_id",
"_required_": true
},
"acl": {
"type": [
"boolean",
"null"
],
"_name_": "acl",
"title": "acl",
"_required_": true
},
"uid": {
"type": [
"integer",
"null"
],
"_name_": "uid",
"title": "uid",
"_required_": true
},
"gid": {
"type": [
"integer",
"null"
],
"_name_": "gid",
"title": "gid",
"_required_": true
},
"is_mountpoint": {
"type": "boolean",
"_name_": "is_mountpoint",
"title": "is_mountpoint",
"_required_": true
},
"is_ctldir": {
"type": "boolean",
"_name_": "is_ctldir",
"title": "is_ctldir",
"_required_": true
},
"attributes": {
"_name_": "attributes",
"title": "attributes",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "statx_attribute",
"title": "statx_attribute",
"_required_": false,
"type": "string",
"enum": [
"COMPRESSED",
"IMMUTABLE",
"APPEND",
"NODUMP",
"ENCRYPTED",
"AUTOMOUNT",
"MOUNT_ROOT",
"VERIFY",
"DAX"
]
}
]
},
"xattrs": {
"_name_": "xattrs",
"title": "xattrs",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"zfs_attrs": {
"_name_": "zfs_attrs",
"title": "zfs_attrs",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
}
},
"additionalProperties": false,
"_name_": "path_entry",
"title": "path_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"path",
"realpath",
"type",
"size",
"allocation_size",
"mode",
"mount_id",
"acl",
"uid",
"gid",
"is_mountpoint",
"is_ctldir",
"attributes",
"xattrs",
"zfs_attrs"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"realpath": {
"_name_": "realpath",
"title": "realpath",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"DIRECTORY",
"FILE",
"SYMLINK",
"OTHER"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocation_size": {
"type": [
"integer",
"null"
],
"_name_": "allocation_size",
"title": "allocation_size",
"_required_": true
},
"mode": {
"type": [
"integer",
"null"
],
"_name_": "mode",
"title": "mode",
"_required_": true
},
"mount_id": {
"type": [
"integer",
"null"
],
"_name_": "mount_id",
"title": "mount_id",
"_required_": true
},
"acl": {
"type": [
"boolean",
"null"
],
"_name_": "acl",
"title": "acl",
"_required_": true
},
"uid": {
"type": [
"integer",
"null"
],
"_name_": "uid",
"title": "uid",
"_required_": true
},
"gid": {
"type": [
"integer",
"null"
],
"_name_": "gid",
"title": "gid",
"_required_": true
},
"is_mountpoint": {
"type": "boolean",
"_name_": "is_mountpoint",
"title": "is_mountpoint",
"_required_": true
},
"is_ctldir": {
"type": "boolean",
"_name_": "is_ctldir",
"title": "is_ctldir",
"_required_": true
},
"attributes": {
"_name_": "attributes",
"title": "attributes",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "statx_attribute",
"title": "statx_attribute",
"_required_": false,
"type": "string",
"enum": [
"COMPRESSED",
"IMMUTABLE",
"APPEND",
"NODUMP",
"ENCRYPTED",
"AUTOMOUNT",
"MOUNT_ROOT",
"VERIFY",
"DAX"
]
}
]
},
"xattrs": {
"_name_": "xattrs",
"title": "xattrs",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"zfs_attrs": {
"_name_": "zfs_attrs",
"title": "zfs_attrs",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
}
},
"additionalProperties": false,
"_name_": "path_entry",
"title": "path_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"path",
"realpath",
"type",
"size",
"allocation_size",
"mode",
"mount_id",
"acl",
"uid",
"gid",
"is_mountpoint",
"is_ctldir",
"attributes",
"xattrs",
"zfs_attrs"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Get the contents of a directory. The select option may be used to optimize listdir performance. Metadata-related fields that are not selected will not be retrieved from the filesystem. For example {"select": ["path", "type"]} will avoid querying an xattr list and ZFS attributes for files in a directory. NOTE: an empty list for select (default) is treated as requesting all information. Each entry of the list consists of: name(str): name of the file path(str): absolute path of the entry realpath(str): absolute real path of the entry (if SYMLINK) type(str): DIRECTORY | FILE | SYMLINK | OTHER size(int): size of the entry allocation_size(int): on-disk size of entry mode(int): file mode/permission uid(int): user id of entry owner gid(int): group id of entry owner acl(bool): extended ACL is present on file is_mountpoint(bool): path is a mountpoint is_ctldir(bool): path is within special .zfs directory attributes(list): list of statx file attributes that apply to the file. See statx(2) manpage for more details. xattrs(list): list of extended attribute names. zfs_attrs(list): list of ZFS file attributes on file |
filesystem.mkdir |
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"options": {
"type": "object",
"properties": {
"mode": {
"_name_": "mode",
"title": "mode",
"default": "755",
"_required_": false,
"type": "string"
},
"raise_chmod_error": {
"type": "boolean",
"_name_": "raise_chmod_error",
"title": "raise_chmod_error",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"mode",
"raise_chmod_error"
]
}
},
"additionalProperties": false,
"_name_": "filesystem_mkdir",
"title": "filesystem_mkdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"options"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"realpath": {
"_name_": "realpath",
"title": "realpath",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"DIRECTORY",
"FILE",
"SYMLINK",
"OTHER"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocation_size": {
"type": [
"integer",
"null"
],
"_name_": "allocation_size",
"title": "allocation_size",
"_required_": true
},
"mode": {
"type": [
"integer",
"null"
],
"_name_": "mode",
"title": "mode",
"_required_": true,
"description": "`mode` - specify the permissions to set on the new directory (0o755 is default).\n`raise_chmod_error` - choose whether to raise an exception if the attempt to set\nmode fails. In this case, the newly created directory will be removed to prevent\nuse with unintended permissions."
},
"mount_id": {
"type": [
"integer",
"null"
],
"_name_": "mount_id",
"title": "mount_id",
"_required_": true
},
"acl": {
"type": [
"boolean",
"null"
],
"_name_": "acl",
"title": "acl",
"_required_": true
},
"uid": {
"type": [
"integer",
"null"
],
"_name_": "uid",
"title": "uid",
"_required_": true
},
"gid": {
"type": [
"integer",
"null"
],
"_name_": "gid",
"title": "gid",
"_required_": true
},
"is_mountpoint": {
"type": "boolean",
"_name_": "is_mountpoint",
"title": "is_mountpoint",
"_required_": true
},
"is_ctldir": {
"type": "boolean",
"_name_": "is_ctldir",
"title": "is_ctldir",
"_required_": true
},
"attributes": {
"_name_": "attributes",
"title": "attributes",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "statx_attribute",
"title": "statx_attribute",
"_required_": false,
"type": "string",
"enum": [
"COMPRESSED",
"IMMUTABLE",
"APPEND",
"NODUMP",
"ENCRYPTED",
"AUTOMOUNT",
"MOUNT_ROOT",
"VERIFY",
"DAX"
]
}
]
},
"xattrs": {
"_name_": "xattrs",
"title": "xattrs",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"zfs_attrs": {
"_name_": "zfs_attrs",
"title": "zfs_attrs",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
}
},
"additionalProperties": false,
"_name_": "path_entry",
"title": "path_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"path",
"realpath",
"type",
"size",
"allocation_size",
"mode",
"mount_id",
"acl",
"uid",
"gid",
"is_mountpoint",
"is_ctldir",
"attributes",
"xattrs",
"zfs_attrs"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_DATA_WRITE, FILESYSTEM_FULL_CONTROL |
Create a directory at the specified path. The following options are supported:
NOTE: if chmod error is skipped, the resulting |
filesystem.put |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"append": {
"type": "boolean",
"_name_": "append",
"title": "append",
"default": false,
"_required_": false
},
"mode": {
"type": "integer",
"_name_": "mode",
"title": "mode",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"append",
"mode"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successful_put",
"title": "successful_put",
"_required_": false
}
|
Job to put contents to |
filesystem.set_immutable |
---|
Arguments:
{
"type": "boolean",
"_name_": "set_flag",
"title": "set_flag",
"_required_": false
}
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string",
"description": "Set/Unset immutable flag at `path`."
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, SHARING_ADMIN |
Set/Unset immutable flag at
|
filesystem.set_zfs_attributes |
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"zfs_file_attributes": {
"type": "object",
"properties": {
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"_required_": false
},
"hidden": {
"type": "boolean",
"_name_": "hidden",
"title": "hidden",
"_required_": false
},
"system": {
"type": "boolean",
"_name_": "system",
"title": "system",
"_required_": false
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false
},
"immutable": {
"type": "boolean",
"_name_": "immutable",
"title": "immutable",
"_required_": false
},
"nounlink": {
"type": "boolean",
"_name_": "nounlink",
"title": "nounlink",
"_required_": false
},
"appendonly": {
"type": "boolean",
"_name_": "appendonly",
"title": "appendonly",
"_required_": false
},
"offline": {
"type": "boolean",
"_name_": "offline",
"title": "offline",
"_required_": false
},
"sparse": {
"type": "boolean",
"_name_": "sparse",
"title": "sparse",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "zfs_file_attributes",
"title": "zfs_file_attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"readonly",
"hidden",
"system",
"archive",
"immutable",
"nounlink",
"appendonly",
"offline",
"sparse"
]
}
},
"additionalProperties": false,
"_name_": "set_zfs_file_attributes",
"title": "set_zfs_file_attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"zfs_file_attributes"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, SHARING_ADMIN |
Set special ZFS-related file flags on the specified path
|
filesystem.setacl
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"uid": {
"type": [
"integer",
"null"
],
"_name_": "uid",
"title": "uid",
"default": null,
"_required_": false
},
"gid": {
"type": [
"integer",
"null"
],
"_name_": "gid",
"title": "gid",
"default": null,
"_required_": false
},
"dacl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "dacl",
"description": null,
"_required_": false
},
"nfs41_flags": {
"type": "object",
"properties": {
"autoinherit": {
"type": "boolean",
"_name_": "autoinherit",
"title": "autoinherit",
"default": false,
"_required_": false
},
"protected": {
"type": "boolean",
"_name_": "protected",
"title": "protected",
"default": false,
"_required_": false
},
"defaulted": {
"type": "boolean",
"_name_": "defaulted",
"title": "defaulted",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "nfs41_flags",
"title": "nfs41_flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"autoinherit",
"protected",
"defaulted"
]
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"NFS4",
"POSIX1E",
"DISABLED"
]
},
"options": {
"type": "object",
"properties": {
"stripacl": {
"type": "boolean",
"_name_": "stripacl",
"title": "stripacl",
"default": false,
"_required_": false
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
},
"traverse": {
"type": "boolean",
"_name_": "traverse",
"title": "traverse",
"default": false,
"_required_": false
},
"canonicalize": {
"type": "boolean",
"_name_": "canonicalize",
"title": "canonicalize",
"default": true,
"_required_": false
},
"validate_effective_acl": {
"type": "boolean",
"_name_": "validate_effective_acl",
"title": "validate_effective_acl",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"stripacl",
"recursive",
"traverse",
"canonicalize",
"validate_effective_acl"
]
}
},
"additionalProperties": false,
"_name_": "filesystem_acl",
"title": "filesystem_acl",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"uid",
"gid",
"dacl",
"nfs41_flags",
"acltype",
"options"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, SHARING_ADMIN |
- |
filesystem.setperm
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "Set unix permissions on given `path`.\n`stripacl` setperm will fail if an extended ACL is present on `path`,\nunless `stripacl` is set to True."
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": [
"string",
"null"
],
"description": "If `mode` is specified then the mode will be applied to the\npath and files and subdirectories depending on which `options` are\nselected. Mode should be formatted as string representation of octal\npermissions bits."
},
"uid": {
"type": [
"integer",
"null"
],
"_name_": "uid",
"title": "uid",
"default": null,
"_required_": false,
"description": "`uid` the desired UID of the file user. If set to None (the default), then user is not changed."
},
"gid": {
"type": [
"integer",
"null"
],
"_name_": "gid",
"title": "gid",
"default": null,
"_required_": false,
"description": "`gid` the desired GID of the file group. If set to None (the default), then group is not changed."
},
"options": {
"type": "object",
"properties": {
"stripacl": {
"type": "boolean",
"_name_": "stripacl",
"title": "stripacl",
"default": false,
"_required_": false
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
},
"traverse": {
"type": "boolean",
"_name_": "traverse",
"title": "traverse",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"stripacl",
"recursive",
"traverse"
],
"description": "If `mode` is specified then the mode will be applied to the\npath and files and subdirectories depending on which `options` are\nselected. Mode should be formatted as string representation of octal\npermissions bits."
}
},
"additionalProperties": false,
"_name_": "filesystem_permission",
"title": "filesystem_permission",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"mode",
"uid",
"gid",
"options"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, SHARING_ADMIN |
Set unix permissions on given If
If no |
filesystem.stat |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"realpath": {
"_name_": "realpath",
"title": "realpath",
"_required_": true,
"type": "string"
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": true
},
"allocation_size": {
"type": "integer",
"_name_": "allocation_size",
"title": "allocation_size",
"_required_": true
},
"mode": {
"type": "integer",
"_name_": "mode",
"title": "mode",
"_required_": true
},
"uid": {
"type": "integer",
"_name_": "uid",
"title": "uid",
"_required_": true
},
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": true
},
"atime": {
"type": "float",
"_name_": "atime",
"title": "atime",
"_required_": true
},
"mtime": {
"type": "float",
"_name_": "mtime",
"title": "mtime",
"_required_": true
},
"ctime": {
"type": "float",
"_name_": "ctime",
"title": "ctime",
"_required_": true
},
"btime": {
"type": "float",
"_name_": "btime",
"title": "btime",
"_required_": true
},
"dev": {
"type": "integer",
"_name_": "dev",
"title": "dev",
"_required_": true
},
"mount_id": {
"type": "integer",
"_name_": "mount_id",
"title": "mount_id",
"_required_": true
},
"inode": {
"type": "integer",
"_name_": "inode",
"title": "inode",
"_required_": true
},
"nlink": {
"type": "integer",
"_name_": "nlink",
"title": "nlink",
"_required_": true
},
"is_mountpoint": {
"type": "boolean",
"_name_": "is_mountpoint",
"title": "is_mountpoint",
"_required_": true
},
"is_ctldir": {
"type": "boolean",
"_name_": "is_ctldir",
"title": "is_ctldir",
"_required_": true
},
"attributes": {
"_name_": "attributes",
"title": "attributes",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "statx_attribute",
"title": "statx_attribute",
"_required_": false,
"type": "string",
"enum": [
"COMPRESSED",
"IMMUTABLE",
"APPEND",
"NODUMP",
"ENCRYPTED",
"AUTOMOUNT",
"MOUNT_ROOT",
"VERIFY",
"DAX"
]
}
]
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": [
"string",
"null"
]
},
"group": {
"_name_": "group",
"title": "group",
"_required_": true,
"type": [
"string",
"null"
]
},
"acl": {
"type": "boolean",
"_name_": "acl",
"title": "acl",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "path_stats",
"title": "path_stats",
"default": {},
"_required_": false,
"_attrs_order_": [
"realpath",
"size",
"allocation_size",
"mode",
"uid",
"gid",
"atime",
"mtime",
"ctime",
"btime",
"dev",
"mount_id",
"inode",
"nlink",
"is_mountpoint",
"is_ctldir",
"attributes",
"user",
"group",
"acl"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Return filesystem information for a given path.
|
filesystem.statfs |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"fsid": {
"_name_": "fsid",
"title": "fsid",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"fstype": {
"_name_": "fstype",
"title": "fstype",
"_required_": true,
"type": "string"
},
"source": {
"_name_": "source",
"title": "source",
"_required_": true,
"type": "string"
},
"dest": {
"_name_": "dest",
"title": "dest",
"_required_": true,
"type": "string"
},
"blocksize": {
"type": "integer",
"_name_": "blocksize",
"title": "blocksize",
"_required_": true
},
"total_blocks": {
"type": "integer",
"_name_": "total_blocks",
"title": "total_blocks",
"_required_": true
},
"free_blocks": {
"type": "integer",
"_name_": "free_blocks",
"title": "free_blocks",
"_required_": true
},
"avail_blocks": {
"type": "integer",
"_name_": "avail_blocks",
"title": "avail_blocks",
"_required_": true
},
"total_blocks_str": {
"_name_": "total_blocks_str",
"title": "total_blocks_str",
"_required_": true,
"type": "string"
},
"free_blocks_str": {
"_name_": "free_blocks_str",
"title": "free_blocks_str",
"_required_": true,
"type": "string"
},
"avail_blocks_str": {
"_name_": "avail_blocks_str",
"title": "avail_blocks_str",
"_required_": true,
"type": "string"
},
"files": {
"type": "integer",
"_name_": "files",
"title": "files",
"_required_": true
},
"free_files": {
"type": "integer",
"_name_": "free_files",
"title": "free_files",
"_required_": true
},
"name_max": {
"type": "integer",
"_name_": "name_max",
"title": "name_max",
"_required_": true
},
"total_bytes": {
"type": "integer",
"_name_": "total_bytes",
"title": "total_bytes",
"_required_": true
},
"free_bytes": {
"type": "integer",
"_name_": "free_bytes",
"title": "free_bytes",
"_required_": true
},
"avail_bytes": {
"type": "integer",
"_name_": "avail_bytes",
"title": "avail_bytes",
"_required_": true
},
"total_bytes_str": {
"_name_": "total_bytes_str",
"title": "total_bytes_str",
"_required_": true,
"type": "string"
},
"free_bytes_str": {
"_name_": "free_bytes_str",
"title": "free_bytes_str",
"_required_": true,
"type": "string"
},
"avail_bytes_str": {
"_name_": "avail_bytes_str",
"title": "avail_bytes_str",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "path_statfs",
"title": "path_statfs",
"default": {},
"_required_": false,
"_attrs_order_": [
"flags",
"fsid",
"fstype",
"source",
"dest",
"blocksize",
"total_blocks",
"free_blocks",
"avail_blocks",
"total_blocks_str",
"free_blocks_str",
"avail_blocks_str",
"files",
"free_files",
"name_max",
"total_bytes",
"free_bytes",
"avail_bytes",
"total_bytes_str",
"free_bytes_str",
"avail_bytes_str"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Return stats from the filesystem of a given path. Raises: CallError(ENOENT) - Path not found |
filesystem.acltemplate.by_path |
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"default": "",
"_required_": false,
"type": "string",
"description": "Retrieve list of available ACL templates for a given `path`."
},
"query-filters": {
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
},
"query-options": {
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
},
"format-options": {
"type": "object",
"properties": {
"canonicalize": {
"type": "boolean",
"_name_": "canonicalize",
"title": "canonicalize",
"default": false,
"_required_": false
},
"ensure_builtins": {
"type": "boolean",
"_name_": "ensure_builtins",
"title": "ensure_builtins",
"default": false,
"_required_": false
},
"resolve_names": {
"type": "boolean",
"_name_": "resolve_names",
"title": "resolve_names",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "format-options",
"title": "format-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"canonicalize",
"ensure_builtins",
"resolve_names"
]
}
},
"additionalProperties": false,
"_name_": "acltemplate_by_path",
"title": "acltemplate_by_path",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"query-filters",
"query-options",
"format-options"
]
}
|
Return Arguments:
{
"_name_": "templates",
"title": "templates",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_entry",
"title": "acltemplate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
}
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_READ, FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, READONLY_ADMIN, SHARING_ADMIN |
Retrieve list of available ACL templates for a given Supports
|
filesystem.acltemplate.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_create",
"title": "acltemplate_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "filesystem_acltemplate_create_returns",
"title": "filesystem_acltemplate_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, SHARING_ADMIN |
Create a new filesystem ACL template. |
filesystem.acltemplate.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
- |
filesystem.acltemplate.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_entry",
"title": "acltemplate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
filesystem.acltemplate.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_entry",
"title": "acltemplate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
}
]
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_entry",
"title": "acltemplate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_entry",
"title": "acltemplate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
filesystem.acltemplate.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_update",
"title": "acltemplate_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "filesystem_acltemplate_update_returns",
"title": "filesystem_acltemplate_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
}
|
This method is accessible to the users granted with the following roles: FILESYSTEM_ATTRS_WRITE, FILESYSTEM_FULL_CONTROL, SHARING_ADMIN |
update filesystem ACL template with |
ftp.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"clients": {
"type": "integer",
"_name_": "clients",
"title": "clients",
"_required_": true
},
"ipconnections": {
"type": "integer",
"_name_": "ipconnections",
"title": "ipconnections",
"_required_": true
},
"loginattempt": {
"type": "integer",
"_name_": "loginattempt",
"title": "loginattempt",
"_required_": true
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"_required_": true
},
"timeout_notransfer": {
"type": "integer",
"_name_": "timeout_notransfer",
"title": "timeout_notransfer",
"_required_": false
},
"onlyanonymous": {
"type": "boolean",
"_name_": "onlyanonymous",
"title": "onlyanonymous",
"_required_": true
},
"anonpath": {
"_name_": "anonpath",
"title": "anonpath",
"_required_": true,
"type": [
"string",
"null"
]
},
"onlylocal": {
"type": "boolean",
"_name_": "onlylocal",
"title": "onlylocal",
"_required_": true
},
"banner": {
"_name_": "banner",
"title": "banner",
"_required_": true,
"type": "string"
},
"filemask": {
"_name_": "filemask",
"title": "filemask",
"_required_": true,
"type": "string"
},
"dirmask": {
"_name_": "dirmask",
"title": "dirmask",
"_required_": true,
"type": "string"
},
"fxp": {
"type": "boolean",
"_name_": "fxp",
"title": "fxp",
"_required_": true
},
"resume": {
"type": "boolean",
"_name_": "resume",
"title": "resume",
"_required_": true
},
"defaultroot": {
"type": "boolean",
"_name_": "defaultroot",
"title": "defaultroot",
"_required_": true
},
"ident": {
"type": "boolean",
"_name_": "ident",
"title": "ident",
"_required_": true
},
"reversedns": {
"type": "boolean",
"_name_": "reversedns",
"title": "reversedns",
"_required_": true
},
"masqaddress": {
"_name_": "masqaddress",
"title": "masqaddress",
"_required_": true,
"type": "string"
},
"passiveportsmin": {
"type": "integer",
"_name_": "passiveportsmin",
"title": "passiveportsmin",
"_required_": true
},
"passiveportsmax": {
"type": "integer",
"_name_": "passiveportsmax",
"title": "passiveportsmax",
"_required_": true
},
"localuserbw": {
"type": "integer",
"_name_": "localuserbw",
"title": "localuserbw",
"_required_": true
},
"localuserdlbw": {
"type": "integer",
"_name_": "localuserdlbw",
"title": "localuserdlbw",
"_required_": true
},
"anonuserbw": {
"type": "integer",
"_name_": "anonuserbw",
"title": "anonuserbw",
"_required_": true
},
"anonuserdlbw": {
"type": "integer",
"_name_": "anonuserdlbw",
"title": "anonuserdlbw",
"_required_": true
},
"tls": {
"type": "boolean",
"_name_": "tls",
"title": "tls",
"_required_": true
},
"tls_policy": {
"_name_": "tls_policy",
"title": "tls_policy",
"_required_": true,
"type": "string",
"enum": [
"on",
"off",
"data",
"!data",
"auth",
"ctrl",
"ctrl+data",
"ctrl+!data",
"auth+data",
"auth+!data"
]
},
"tls_opt_allow_client_renegotiations": {
"type": "boolean",
"_name_": "tls_opt_allow_client_renegotiations",
"title": "tls_opt_allow_client_renegotiations",
"_required_": true
},
"tls_opt_allow_dot_login": {
"type": "boolean",
"_name_": "tls_opt_allow_dot_login",
"title": "tls_opt_allow_dot_login",
"_required_": true
},
"tls_opt_allow_per_user": {
"type": "boolean",
"_name_": "tls_opt_allow_per_user",
"title": "tls_opt_allow_per_user",
"_required_": true
},
"tls_opt_common_name_required": {
"type": "boolean",
"_name_": "tls_opt_common_name_required",
"title": "tls_opt_common_name_required",
"_required_": true
},
"tls_opt_enable_diags": {
"type": "boolean",
"_name_": "tls_opt_enable_diags",
"title": "tls_opt_enable_diags",
"_required_": true
},
"tls_opt_export_cert_data": {
"type": "boolean",
"_name_": "tls_opt_export_cert_data",
"title": "tls_opt_export_cert_data",
"_required_": true
},
"tls_opt_no_empty_fragments": {
"type": "boolean",
"_name_": "tls_opt_no_empty_fragments",
"title": "tls_opt_no_empty_fragments",
"_required_": true
},
"tls_opt_no_session_reuse_required": {
"type": "boolean",
"_name_": "tls_opt_no_session_reuse_required",
"title": "tls_opt_no_session_reuse_required",
"_required_": true
},
"tls_opt_stdenvvars": {
"type": "boolean",
"_name_": "tls_opt_stdenvvars",
"title": "tls_opt_stdenvvars",
"_required_": true
},
"tls_opt_dns_name_required": {
"type": "boolean",
"_name_": "tls_opt_dns_name_required",
"title": "tls_opt_dns_name_required",
"_required_": true
},
"tls_opt_ip_address_required": {
"type": "boolean",
"_name_": "tls_opt_ip_address_required",
"title": "tls_opt_ip_address_required",
"_required_": true
},
"ssltls_certificate": {
"type": [
"integer",
"null"
],
"_name_": "ssltls_certificate",
"title": "ssltls_certificate",
"_required_": true
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ftp_entry",
"title": "ftp_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"port",
"clients",
"ipconnections",
"loginattempt",
"timeout",
"timeout_notransfer",
"onlyanonymous",
"anonpath",
"onlylocal",
"banner",
"filemask",
"dirmask",
"fxp",
"resume",
"defaultroot",
"ident",
"reversedns",
"masqaddress",
"passiveportsmin",
"passiveportsmax",
"localuserbw",
"localuserdlbw",
"anonuserbw",
"anonuserdlbw",
"tls",
"tls_policy",
"tls_opt_allow_client_renegotiations",
"tls_opt_allow_dot_login",
"tls_opt_allow_per_user",
"tls_opt_common_name_required",
"tls_opt_enable_diags",
"tls_opt_export_cert_data",
"tls_opt_no_empty_fragments",
"tls_opt_no_session_reuse_required",
"tls_opt_stdenvvars",
"tls_opt_dns_name_required",
"tls_opt_ip_address_required",
"ssltls_certificate",
"options"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
ftp.update |
---|
Arguments:
{
"type": "object",
"properties": {
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"clients": {
"type": "integer",
"_name_": "clients",
"title": "clients",
"_required_": true,
"description": "`clients` is an integer value which sets the maximum number of simultaneous clients allowed. It defaults to 32."
},
"ipconnections": {
"type": "integer",
"_name_": "ipconnections",
"title": "ipconnections",
"_required_": true,
"description": "`ipconnections` is an integer value which shows the maximum number of connections per IP address. It defaults\nto 0 which equals to unlimited."
},
"loginattempt": {
"type": "integer",
"_name_": "loginattempt",
"title": "loginattempt",
"_required_": true
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"_required_": true,
"description": "`timeout` is the maximum number of seconds that proftpd will allow clients to stay connected without receiving\nany data on either the control or data connection."
},
"timeout_notransfer": {
"type": "integer",
"_name_": "timeout_notransfer",
"title": "timeout_notransfer",
"_required_": false,
"description": "`timeout_notransfer` is the maximum number of seconds a client is allowed to spend connected, after\nauthentication, without issuing a command which results in creating an active or passive data connection\n(i.e. sending/receiving a file, or receiving a directory listing)."
},
"onlyanonymous": {
"type": "boolean",
"_name_": "onlyanonymous",
"title": "onlyanonymous",
"_required_": true,
"description": "`onlyanonymous` allows anonymous FTP logins with access to the directory specified by `anonpath`."
},
"anonpath": {
"_name_": "anonpath",
"title": "anonpath",
"_required_": true,
"type": [
"string",
"null"
],
"description": "`onlyanonymous` allows anonymous FTP logins with access to the directory specified by `anonpath`."
},
"onlylocal": {
"type": "boolean",
"_name_": "onlylocal",
"title": "onlylocal",
"_required_": true
},
"banner": {
"_name_": "banner",
"title": "banner",
"_required_": true,
"type": "string",
"description": "`banner` is a message displayed to local login users after they successfully authenticate. It is not displayed\nto anonymous login users."
},
"filemask": {
"_name_": "filemask",
"title": "filemask",
"_required_": true,
"type": "string",
"description": "`filemask` sets the default permissions for newly created files which by default are 077."
},
"dirmask": {
"_name_": "dirmask",
"title": "dirmask",
"_required_": true,
"type": "string",
"description": "`dirmask` sets the default permissions for newly created directories which by default are 077."
},
"fxp": {
"type": "boolean",
"_name_": "fxp",
"title": "fxp",
"_required_": true,
"description": "`fxp` if set to true indicates that File eXchange Protocol is enabled. Generally it is discouraged as it\nmakes the server vulnerable to FTP bounce attacks."
},
"resume": {
"type": "boolean",
"_name_": "resume",
"title": "resume",
"_required_": true,
"description": "`resume` if set allows FTP clients to resume interrupted transfers."
},
"defaultroot": {
"type": "boolean",
"_name_": "defaultroot",
"title": "defaultroot",
"_required_": true,
"description": "`defaultroot` when set ensures that for local users, home directory access is only granted if the user\nis a member of group wheel."
},
"ident": {
"type": "boolean",
"_name_": "ident",
"title": "ident",
"_required_": true,
"description": "`ident` is a boolean value which when set to true indicates that IDENT authentication is required. If identd\nis not running on the client, this can result in timeouts."
},
"reversedns": {
"type": "boolean",
"_name_": "reversedns",
"title": "reversedns",
"_required_": true
},
"masqaddress": {
"_name_": "masqaddress",
"title": "masqaddress",
"_required_": true,
"type": "string",
"description": "`masqaddress` is the public IP address or hostname which is set if FTP clients cannot connect through a\nNAT device."
},
"passiveportsmin": {
"type": "integer",
"_name_": "passiveportsmin",
"title": "passiveportsmin",
"_required_": true
},
"passiveportsmax": {
"type": "integer",
"_name_": "passiveportsmax",
"title": "passiveportsmax",
"_required_": true
},
"localuserbw": {
"type": "integer",
"_name_": "localuserbw",
"title": "localuserbw",
"_required_": true,
"description": "`localuserbw` is a positive integer value which indicates maximum upload bandwidth in KB/s for local user.\nDefault of zero indicates unlimited upload bandwidth ( from the FTP server configuration )."
},
"localuserdlbw": {
"type": "integer",
"_name_": "localuserdlbw",
"title": "localuserdlbw",
"_required_": true,
"description": "`localuserdlbw` is a positive integer value which indicates maximum download bandwidth in KB/s for local user.\nDefault of zero indicates unlimited download bandwidth ( from the FTP server configuration )."
},
"anonuserbw": {
"type": "integer",
"_name_": "anonuserbw",
"title": "anonuserbw",
"_required_": true,
"description": "`anonuserbw` is a positive integer value which indicates maximum upload bandwidth in KB/s for anonymous user.\nDefault of zero indicates unlimited upload bandwidth ( from the FTP server configuration )."
},
"anonuserdlbw": {
"type": "integer",
"_name_": "anonuserdlbw",
"title": "anonuserdlbw",
"_required_": true,
"description": "`anonuserdlbw` is a positive integer value which indicates maximum download bandwidth in KB/s for anonymous\nuser. Default of zero indicates unlimited download bandwidth ( from the FTP server configuration )."
},
"tls": {
"type": "boolean",
"_name_": "tls",
"title": "tls",
"_required_": true,
"description": "`tls` is a boolean value which when set indicates that encrypted connections are enabled. This requires a\ncertificate to be configured first with the certificate service and the id of certificate is passed on in"
},
"tls_policy": {
"_name_": "tls_policy",
"title": "tls_policy",
"_required_": true,
"type": "string",
"enum": [
"on",
"off",
"data",
"!data",
"auth",
"ctrl",
"ctrl+data",
"ctrl+!data",
"auth+data",
"auth+!data"
],
"description": "`tls_policy` defines whether the control channel, data channel, both channels, or neither channel of an FTP\nsession must occur over SSL/TLS."
},
"tls_opt_allow_client_renegotiations": {
"type": "boolean",
"_name_": "tls_opt_allow_client_renegotiations",
"title": "tls_opt_allow_client_renegotiations",
"_required_": true
},
"tls_opt_allow_dot_login": {
"type": "boolean",
"_name_": "tls_opt_allow_dot_login",
"title": "tls_opt_allow_dot_login",
"_required_": true
},
"tls_opt_allow_per_user": {
"type": "boolean",
"_name_": "tls_opt_allow_per_user",
"title": "tls_opt_allow_per_user",
"_required_": true
},
"tls_opt_common_name_required": {
"type": "boolean",
"_name_": "tls_opt_common_name_required",
"title": "tls_opt_common_name_required",
"_required_": true
},
"tls_opt_enable_diags": {
"type": "boolean",
"_name_": "tls_opt_enable_diags",
"title": "tls_opt_enable_diags",
"_required_": true,
"description": "`tls_opt_enable_diags` is a boolean value when set, logs verbosely. This is helpful when troubleshooting a\nconnection."
},
"tls_opt_export_cert_data": {
"type": "boolean",
"_name_": "tls_opt_export_cert_data",
"title": "tls_opt_export_cert_data",
"_required_": true
},
"tls_opt_no_empty_fragments": {
"type": "boolean",
"_name_": "tls_opt_no_empty_fragments",
"title": "tls_opt_no_empty_fragments",
"_required_": true
},
"tls_opt_no_session_reuse_required": {
"type": "boolean",
"_name_": "tls_opt_no_session_reuse_required",
"title": "tls_opt_no_session_reuse_required",
"_required_": true
},
"tls_opt_stdenvvars": {
"type": "boolean",
"_name_": "tls_opt_stdenvvars",
"title": "tls_opt_stdenvvars",
"_required_": true
},
"tls_opt_dns_name_required": {
"type": "boolean",
"_name_": "tls_opt_dns_name_required",
"title": "tls_opt_dns_name_required",
"_required_": true
},
"tls_opt_ip_address_required": {
"type": "boolean",
"_name_": "tls_opt_ip_address_required",
"title": "tls_opt_ip_address_required",
"_required_": true
},
"ssltls_certificate": {
"type": [
"integer",
"null"
],
"_name_": "ssltls_certificate",
"title": "ssltls_certificate",
"_required_": true,
"description": "`ssltls_certificate`."
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ftp_update",
"title": "ftp_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"port",
"clients",
"ipconnections",
"loginattempt",
"timeout",
"timeout_notransfer",
"onlyanonymous",
"anonpath",
"onlylocal",
"banner",
"filemask",
"dirmask",
"fxp",
"resume",
"defaultroot",
"ident",
"reversedns",
"masqaddress",
"passiveportsmin",
"passiveportsmax",
"localuserbw",
"localuserdlbw",
"anonuserbw",
"anonuserdlbw",
"tls",
"tls_policy",
"tls_opt_allow_client_renegotiations",
"tls_opt_allow_dot_login",
"tls_opt_allow_per_user",
"tls_opt_common_name_required",
"tls_opt_enable_diags",
"tls_opt_export_cert_data",
"tls_opt_no_empty_fragments",
"tls_opt_no_session_reuse_required",
"tls_opt_stdenvvars",
"tls_opt_dns_name_required",
"tls_opt_ip_address_required",
"ssltls_certificate",
"options"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"clients": {
"type": "integer",
"_name_": "clients",
"title": "clients",
"_required_": true,
"description": "`clients` is an integer value which sets the maximum number of simultaneous clients allowed. It defaults to 32."
},
"ipconnections": {
"type": "integer",
"_name_": "ipconnections",
"title": "ipconnections",
"_required_": true,
"description": "`ipconnections` is an integer value which shows the maximum number of connections per IP address. It defaults\nto 0 which equals to unlimited."
},
"loginattempt": {
"type": "integer",
"_name_": "loginattempt",
"title": "loginattempt",
"_required_": true
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"_required_": true,
"description": "`timeout` is the maximum number of seconds that proftpd will allow clients to stay connected without receiving\nany data on either the control or data connection."
},
"timeout_notransfer": {
"type": "integer",
"_name_": "timeout_notransfer",
"title": "timeout_notransfer",
"_required_": false,
"description": "`timeout_notransfer` is the maximum number of seconds a client is allowed to spend connected, after\nauthentication, without issuing a command which results in creating an active or passive data connection\n(i.e. sending/receiving a file, or receiving a directory listing)."
},
"onlyanonymous": {
"type": "boolean",
"_name_": "onlyanonymous",
"title": "onlyanonymous",
"_required_": true,
"description": "`onlyanonymous` allows anonymous FTP logins with access to the directory specified by `anonpath`."
},
"anonpath": {
"_name_": "anonpath",
"title": "anonpath",
"_required_": true,
"type": [
"string",
"null"
],
"description": "`onlyanonymous` allows anonymous FTP logins with access to the directory specified by `anonpath`."
},
"onlylocal": {
"type": "boolean",
"_name_": "onlylocal",
"title": "onlylocal",
"_required_": true
},
"banner": {
"_name_": "banner",
"title": "banner",
"_required_": true,
"type": "string",
"description": "`banner` is a message displayed to local login users after they successfully authenticate. It is not displayed\nto anonymous login users."
},
"filemask": {
"_name_": "filemask",
"title": "filemask",
"_required_": true,
"type": "string",
"description": "`filemask` sets the default permissions for newly created files which by default are 077."
},
"dirmask": {
"_name_": "dirmask",
"title": "dirmask",
"_required_": true,
"type": "string",
"description": "`dirmask` sets the default permissions for newly created directories which by default are 077."
},
"fxp": {
"type": "boolean",
"_name_": "fxp",
"title": "fxp",
"_required_": true,
"description": "`fxp` if set to true indicates that File eXchange Protocol is enabled. Generally it is discouraged as it\nmakes the server vulnerable to FTP bounce attacks."
},
"resume": {
"type": "boolean",
"_name_": "resume",
"title": "resume",
"_required_": true,
"description": "`resume` if set allows FTP clients to resume interrupted transfers."
},
"defaultroot": {
"type": "boolean",
"_name_": "defaultroot",
"title": "defaultroot",
"_required_": true,
"description": "`defaultroot` when set ensures that for local users, home directory access is only granted if the user\nis a member of group wheel."
},
"ident": {
"type": "boolean",
"_name_": "ident",
"title": "ident",
"_required_": true,
"description": "`ident` is a boolean value which when set to true indicates that IDENT authentication is required. If identd\nis not running on the client, this can result in timeouts."
},
"reversedns": {
"type": "boolean",
"_name_": "reversedns",
"title": "reversedns",
"_required_": true
},
"masqaddress": {
"_name_": "masqaddress",
"title": "masqaddress",
"_required_": true,
"type": "string",
"description": "`masqaddress` is the public IP address or hostname which is set if FTP clients cannot connect through a\nNAT device."
},
"passiveportsmin": {
"type": "integer",
"_name_": "passiveportsmin",
"title": "passiveportsmin",
"_required_": true
},
"passiveportsmax": {
"type": "integer",
"_name_": "passiveportsmax",
"title": "passiveportsmax",
"_required_": true
},
"localuserbw": {
"type": "integer",
"_name_": "localuserbw",
"title": "localuserbw",
"_required_": true,
"description": "`localuserbw` is a positive integer value which indicates maximum upload bandwidth in KB/s for local user.\nDefault of zero indicates unlimited upload bandwidth ( from the FTP server configuration )."
},
"localuserdlbw": {
"type": "integer",
"_name_": "localuserdlbw",
"title": "localuserdlbw",
"_required_": true,
"description": "`localuserdlbw` is a positive integer value which indicates maximum download bandwidth in KB/s for local user.\nDefault of zero indicates unlimited download bandwidth ( from the FTP server configuration )."
},
"anonuserbw": {
"type": "integer",
"_name_": "anonuserbw",
"title": "anonuserbw",
"_required_": true,
"description": "`anonuserbw` is a positive integer value which indicates maximum upload bandwidth in KB/s for anonymous user.\nDefault of zero indicates unlimited upload bandwidth ( from the FTP server configuration )."
},
"anonuserdlbw": {
"type": "integer",
"_name_": "anonuserdlbw",
"title": "anonuserdlbw",
"_required_": true,
"description": "`anonuserdlbw` is a positive integer value which indicates maximum download bandwidth in KB/s for anonymous\nuser. Default of zero indicates unlimited download bandwidth ( from the FTP server configuration )."
},
"tls": {
"type": "boolean",
"_name_": "tls",
"title": "tls",
"_required_": true,
"description": "`tls` is a boolean value which when set indicates that encrypted connections are enabled. This requires a\ncertificate to be configured first with the certificate service and the id of certificate is passed on in"
},
"tls_policy": {
"_name_": "tls_policy",
"title": "tls_policy",
"_required_": true,
"type": "string",
"enum": [
"on",
"off",
"data",
"!data",
"auth",
"ctrl",
"ctrl+data",
"ctrl+!data",
"auth+data",
"auth+!data"
],
"description": "`tls_policy` defines whether the control channel, data channel, both channels, or neither channel of an FTP\nsession must occur over SSL/TLS."
},
"tls_opt_allow_client_renegotiations": {
"type": "boolean",
"_name_": "tls_opt_allow_client_renegotiations",
"title": "tls_opt_allow_client_renegotiations",
"_required_": true
},
"tls_opt_allow_dot_login": {
"type": "boolean",
"_name_": "tls_opt_allow_dot_login",
"title": "tls_opt_allow_dot_login",
"_required_": true
},
"tls_opt_allow_per_user": {
"type": "boolean",
"_name_": "tls_opt_allow_per_user",
"title": "tls_opt_allow_per_user",
"_required_": true
},
"tls_opt_common_name_required": {
"type": "boolean",
"_name_": "tls_opt_common_name_required",
"title": "tls_opt_common_name_required",
"_required_": true
},
"tls_opt_enable_diags": {
"type": "boolean",
"_name_": "tls_opt_enable_diags",
"title": "tls_opt_enable_diags",
"_required_": true,
"description": "`tls_opt_enable_diags` is a boolean value when set, logs verbosely. This is helpful when troubleshooting a\nconnection."
},
"tls_opt_export_cert_data": {
"type": "boolean",
"_name_": "tls_opt_export_cert_data",
"title": "tls_opt_export_cert_data",
"_required_": true
},
"tls_opt_no_empty_fragments": {
"type": "boolean",
"_name_": "tls_opt_no_empty_fragments",
"title": "tls_opt_no_empty_fragments",
"_required_": true
},
"tls_opt_no_session_reuse_required": {
"type": "boolean",
"_name_": "tls_opt_no_session_reuse_required",
"title": "tls_opt_no_session_reuse_required",
"_required_": true
},
"tls_opt_stdenvvars": {
"type": "boolean",
"_name_": "tls_opt_stdenvvars",
"title": "tls_opt_stdenvvars",
"_required_": true
},
"tls_opt_dns_name_required": {
"type": "boolean",
"_name_": "tls_opt_dns_name_required",
"title": "tls_opt_dns_name_required",
"_required_": true
},
"tls_opt_ip_address_required": {
"type": "boolean",
"_name_": "tls_opt_ip_address_required",
"title": "tls_opt_ip_address_required",
"_required_": true
},
"ssltls_certificate": {
"type": [
"integer",
"null"
],
"_name_": "ssltls_certificate",
"title": "ssltls_certificate",
"_required_": true,
"description": "`ssltls_certificate`."
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ftp_update_returns",
"title": "ftp_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"port",
"clients",
"ipconnections",
"loginattempt",
"timeout",
"timeout_notransfer",
"onlyanonymous",
"anonpath",
"onlylocal",
"banner",
"filemask",
"dirmask",
"fxp",
"resume",
"defaultroot",
"ident",
"reversedns",
"masqaddress",
"passiveportsmin",
"passiveportsmax",
"localuserbw",
"localuserdlbw",
"anonuserbw",
"anonuserdlbw",
"tls",
"tls_policy",
"tls_opt_allow_client_renegotiations",
"tls_opt_allow_dot_login",
"tls_opt_allow_per_user",
"tls_opt_common_name_required",
"tls_opt_enable_diags",
"tls_opt_export_cert_data",
"tls_opt_no_empty_fragments",
"tls_opt_no_session_reuse_required",
"tls_opt_stdenvvars",
"tls_opt_dns_name_required",
"tls_opt_ip_address_required",
"ssltls_certificate",
"options"
]
}
|
Update ftp service configuration.
|
group.create |
---|
Arguments:
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false,
"description": "If `gid` is not provided it is automatically filled with the next one available."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"allow_duplicate_gid": {
"type": "boolean",
"_name_": "allow_duplicate_gid",
"title": "allow_duplicate_gid",
"default": false,
"_required_": false,
"description": "`allow_duplicate_gid` allows distinct group names to share the same gid."
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
],
"description": "`users` is a list of user ids (`id` attribute from `user.query`)."
}
},
"additionalProperties": false,
"_name_": "group_create",
"title": "group_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"allow_duplicate_gid",
"users"
]
}
|
Return Arguments:
{
"type": "integer",
"_name_": "primary_key",
"title": "primary_key",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_WRITE |
Create a new group. If
|
group.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete group `id`."
}
{
"type": "object",
"properties": {
"delete_users": {
"type": "boolean",
"_name_": "delete_users",
"title": "delete_users",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"delete_users"
]
}
|
Return Arguments:
{
"type": "integer",
"_name_": "primary_key",
"title": "primary_key",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_WRITE |
Delete group The |
group.get_group_obj |
---|
Arguments:
{
"type": "object",
"properties": {
"groupname": {
"_name_": "groupname",
"title": "groupname",
"default": null,
"_required_": false,
"type": "string",
"description": "Returns dictionary containing information from struct grp for the group specified by either\nthe `groupname` or `gid`."
},
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"default": null,
"_required_": false,
"description": "Returns dictionary containing information from struct grp for the group specified by either\nthe `groupname` or `gid`."
},
"sid_info": {
"type": "boolean",
"_name_": "sid_info",
"title": "sid_info",
"default": false,
"_required_": false,
"description": "If `sid_info` is specified then addition SMB / domain information is returned for the\ngroup.\n`sid` - optional SID value for the account that is present if `sid_info` is specified in payload."
}
},
"additionalProperties": false,
"_name_": "get_group_obj",
"title": "get_group_obj",
"default": {},
"_required_": false,
"_attrs_order_": [
"groupname",
"gid",
"sid_info"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"gr_name": {
"_name_": "gr_name",
"title": "gr_name",
"_required_": false,
"type": "string",
"description": "`gr_name` - name of the group"
},
"gr_gid": {
"type": "integer",
"_name_": "gr_gid",
"title": "gr_gid",
"_required_": false,
"description": "`gr_gid` - group id of the group"
},
"gr_mem": {
"_name_": "gr_mem",
"title": "gr_mem",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`gr_mem` - list of gids that are members of the group"
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`sid` - optional SID value for the account that is present if `sid_info` is specified in payload."
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"ACTIVEDIRECTORY",
"LDAP"
]
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false,
"description": "`local` - boolean indicating whether this group is local to the NAS or provided by a\ndirectory service."
}
},
"additionalProperties": false,
"_name_": "group_info",
"title": "group_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"gr_name",
"gr_gid",
"gr_mem",
"sid",
"source",
"local"
]
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns dictionary containing information from struct grp for the group specified by either
the If Output contains following keys:
|
group.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
group.get_next_gid |
---|
Return Arguments:
{
"type": "integer",
"_name_": "next_available_gid",
"title": "next_available_gid",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Get the next available/free gid. |
group.has_password_enabled_user |
---|
Arguments:
{
"_name_": "gids",
"title": "gids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
}
]
}
{
"_name_": "exclude_user_ids",
"title": "exclude_user_ids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "exclude_user_id",
"title": "exclude_user_id",
"_required_": false
}
]
}
|
Checks whether at least one local user with a password is a member of any of the |
group.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query groups with |
group.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "`users` is a list of user ids (`id` attribute from `user.query`)."
}
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false,
"description": "If `gid` is not provided it is automatically filled with the next one available."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"allow_duplicate_gid": {
"type": "boolean",
"_name_": "allow_duplicate_gid",
"title": "allow_duplicate_gid",
"default": false,
"_required_": false,
"description": "`allow_duplicate_gid` allows distinct group names to share the same gid."
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
],
"description": "`users` is a list of user ids (`id` attribute from `user.query`)."
}
},
"additionalProperties": false,
"_name_": "group_update",
"title": "group_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"allow_duplicate_gid",
"users"
]
}
|
Return Arguments:
{
"type": "integer",
"_name_": "primary_key",
"title": "primary_key",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_WRITE |
Update attributes of an existing group. |
hardware.cpu.available_governors |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "governor",
"title": "governor",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
Return available cpu governors |
hardware.cpu.current_governor |
---|
Return Arguments:
{
"_name_": "governor",
"title": "governor",
"_required_": false,
"type": "string"
}
|
Returns currently set cpu governor |
hardware.cpu.set_governor |
---|
Arguments:
{
"_name_": "governor",
"title": "governor",
"_required_": true,
"type": "string"
}
|
Set the cpu governor to |
hardware.memory.error_info |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "mem_ctrl",
"title": "mem_ctrl",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
- |
idmap.backend_choices |
---|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns array of valid idmap backend choices per directory service. |
idmap.backend_options |
---|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
This returns full information about idmap backend options. Not all
|
idmap.clear_idmap_cache
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Stop samba, remove the winbindd_cache.tdb file, start samba, flush samba's cache. This should be performed after finalizing idmap changes. |
idmap.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` the pre-windows 2000 domain name."
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
],
"description": "`idmap_backend` provides a plugin interface for Winbind to use varying\nbackends to store SID/uid/gid mapping tables. The correct setting\ndepends on the environment in which the NAS is deployed."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": "`options` are additional parameters that are backend-dependent:",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_domain_create",
"title": "idmap_domain_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` the pre-windows 2000 domain name."
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
],
"description": "`idmap_backend` provides a plugin interface for Winbind to use varying\nbackends to store SID/uid/gid mapping tables. The correct setting\ndepends on the environment in which the NAS is deployed."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": "`options` are additional parameters that are backend-dependent:",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_create_returns",
"title": "idmap_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Create a new IDMAP domain. These domains must be unique. This table will be automatically populated after joining an Active Directory domain if "allow trusted domains" is set to True in the AD service configuration. There are three default system domains: DS_TYPE_ACTIVEDIRECTORY, DS_TYPE_LDAP, DS_TYPE_DEFAULT_DOMAIN. The system domains correspond with the idmap settings under Active Directory, LDAP, and SMB respectively.
|
idmap.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Delete a domain by id. Deletion of default system domains is not permitted. |
idmap.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
]
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "idmap_domain_entry",
"title": "idmap_domain_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
idmap.options_choices |
---|
Arguments:
{
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": false,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns a list of supported keys for the specified idmap backend. |
idmap.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
]
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_domain_entry",
"title": "idmap_domain_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
]
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_domain_entry",
"title": "idmap_domain_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
]
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_domain_entry",
"title": "idmap_domain_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
idmap.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` the pre-windows 2000 domain name."
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
],
"description": "`idmap_backend` provides a plugin interface for Winbind to use varying\nbackends to store SID/uid/gid mapping tables. The correct setting\ndepends on the environment in which the NAS is deployed."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": "`options` are additional parameters that are backend-dependent:",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_update",
"title": "idmap_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` the pre-windows 2000 domain name."
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true,
"description": "`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative.\n`range_low` and `range_high` specify the UID and GID range for which this backend is authoritative."
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
],
"description": "`idmap_backend` provides a plugin interface for Winbind to use varying\nbackends to store SID/uid/gid mapping tables. The correct setting\ndepends on the environment in which the NAS is deployed."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": "`options` are additional parameters that are backend-dependent:",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_update_returns",
"title": "idmap_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Update a domain by id. |
initshutdownscript.create |
---|
Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
],
"description": "`type` indicates if a command or script should be executed at `when`."
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
],
"description": "`type` indicates if a command or script should be executed at `when`.\nThere are three choices for `when`:"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "init_shutdown_script_create",
"title": "init_shutdown_script_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
],
"description": "`type` indicates if a command or script should be executed at `when`."
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
],
"description": "`type` indicates if a command or script should be executed at `when`.\nThere are three choices for `when`:"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "initshutdownscript_create_returns",
"title": "initshutdownscript_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment",
"id"
]
}
|
Create an initshutdown script task.
There are three choices for 1) PREINIT - This is early in the boot process before all the services have started 2) POSTINIT - This is late in the boot process when most of the services have started 3) SHUTDOWN - This is on shutdown
|
initshutdownscript.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete init/shutdown task of |
initshutdownscript.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
]
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "init_shutdown_script_entry",
"title": "init_shutdown_script_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
initshutdownscript.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
]
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "init_shutdown_script_entry",
"title": "init_shutdown_script_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
]
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "init_shutdown_script_entry",
"title": "init_shutdown_script_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
]
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "init_shutdown_script_entry",
"title": "init_shutdown_script_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
initshutdownscript.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update initshutdown script task of `id`.\nCreate an initshutdown script task."
}
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
],
"description": "`type` indicates if a command or script should be executed at `when`."
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
],
"description": "`type` indicates if a command or script should be executed at `when`.\nThere are three choices for `when`:"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "initshutdownscript_update",
"title": "initshutdownscript_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
],
"description": "`type` indicates if a command or script should be executed at `when`."
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
],
"description": "`type` indicates if a command or script should be executed at `when`.\nThere are three choices for `when`:"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update initshutdown script task of `id`.\nCreate an initshutdown script task."
}
},
"additionalProperties": false,
"_name_": "initshutdownscript_update_returns",
"title": "initshutdownscript_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment",
"id"
]
}
|
Update initshutdown script task of |
interface.bridge_members_choices |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "bridge_members_choices",
"title": "bridge_members_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return available interface choices that can be added to a
|
interface.cancel_rollback |
---|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
If this method is called after interface changes have been committed and within the checkin timeout, then the task that automatically rolls back any interface changes is cancelled and the in-memory snapshot of database tables for the various interface tables will NOT be cleared. |
interface.checkin |
---|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
If this method is called after interface changes have been committed and within the checkin timeout, then the task that automatically rolls back any interface changes is cancelled and the in-memory snapshot of database tables for the various interface tables will be cleared. The idea is that the end-user has verified the changes work as intended and need to be committed permanently. |
interface.checkin_waiting |
---|
Return Arguments:
{
"type": [
"integer",
"null"
],
"_name_": "remaining_seconds",
"title": "remaining_seconds",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Returns whether we are waiting user to check in the applied network changes before they are rolled back. Value is in number of seconds or null. |
interface.choices |
---|
Arguments:
{
"type": "object",
"properties": {
"bridge_members": {
"type": "boolean",
"_name_": "bridge_members",
"title": "bridge_members",
"default": false,
"_required_": false,
"description": "`bridge_members` will include BRIDGE members."
},
"lag_ports": {
"type": "boolean",
"_name_": "lag_ports",
"title": "lag_ports",
"default": false,
"_required_": false,
"description": "`lag_ports` will include LINK_AGGREGATION ports."
},
"vlan_parent": {
"type": "boolean",
"_name_": "vlan_parent",
"title": "vlan_parent",
"default": true,
"_required_": false,
"description": "`vlan_parent` will include VLAN parent interface."
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [
"epair",
"tap",
"vnet"
],
"_required_": false,
"type": "array",
"items": [],
"description": "`exclude` is a list of interfaces prefix to remove."
},
"exclude_types": {
"_name_": "exclude_types",
"title": "exclude_types",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"BRIDGE",
"LINK_AGGREGATION",
"PHYSICAL",
"UNKNOWN",
"VLAN"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"bridge_members",
"lag_ports",
"vlan_parent",
"exclude",
"exclude_types",
"include"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "available_interfaces",
"title": "available_interfaces",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
Choices of available network interfaces.
|
interface.commit |
---|
Arguments:
{
"type": "object",
"properties": {
"rollback": {
"type": "boolean",
"_name_": "rollback",
"title": "rollback",
"default": true,
"_required_": false,
"description": "`rollback` as true (default) will roll back changes in case they fail to apply."
},
"checkin_timeout": {
"type": "integer",
"_name_": "checkin_timeout",
"title": "checkin_timeout",
"default": 60,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rollback",
"checkin_timeout"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Commit/apply pending interfaces changes.
|
interface.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"BRIDGE",
"LINK_AGGREGATION",
"VLAN"
],
"description": "For BRIDGE `type` the following attribute is required: bridge_members.\nFor LINK_AGGREGATION `type` the following attributes are required: lag_ports,\nlag_protocol.\nFor VLAN `type` the following attributes are required: vlan_parent_interface,\nvlan_tag and vlan_pcp."
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"default": false,
"_required_": false
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"default": false,
"_required_": false
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "INET",
"_required_": true,
"type": "string",
"enum": [
"INET",
"INET6"
]
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"type": "integer",
"_name_": "netmask",
"title": "netmask",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "interface_alias",
"title": "interface_alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"failover_critical": {
"type": "boolean",
"_name_": "failover_critical",
"title": "failover_critical",
"default": false,
"_required_": false
},
"failover_group": {
"type": [
"integer",
"null"
],
"_name_": "failover_group",
"title": "failover_group",
"_required_": false
},
"failover_vhid": {
"type": [
"integer",
"null"
],
"_name_": "failover_vhid",
"title": "failover_vhid",
"_required_": false
},
"failover_aliases": {
"_name_": "failover_aliases",
"title": "failover_aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "INET",
"_required_": true,
"type": "string",
"enum": [
"INET",
"INET6"
]
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "interface_failover_alias",
"title": "interface_failover_alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address"
]
}
]
},
"failover_virtual_aliases": {
"_name_": "failover_virtual_aliases",
"title": "failover_virtual_aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "INET",
"_required_": true,
"type": "string",
"enum": [
"INET",
"INET6"
]
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "interface_virtual_alias",
"title": "interface_virtual_alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address"
]
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"default": true,
"_required_": false
},
"stp": {
"type": "boolean",
"_name_": "stp",
"title": "stp",
"default": true,
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string",
"enum": [
"LACP",
"FAILOVER",
"LOADBALANCE",
"ROUNDROBIN",
"NONE"
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LAYER2",
"LAYER2+3",
"LAYER3+4"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"SLOW",
"FAST"
]
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "interface",
"title": "interface",
"_required_": false,
"type": "string"
}
]
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": "string"
},
"vlan_tag": {
"type": "integer",
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "interface_create",
"title": "interface_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"description",
"type",
"ipv4_dhcp",
"ipv6_auto",
"aliases",
"failover_critical",
"failover_group",
"failover_vhid",
"failover_aliases",
"failover_virtual_aliases",
"bridge_members",
"enable_learning",
"stp",
"lag_protocol",
"xmit_hash_policy",
"lacpdu_rate",
"lag_ports",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"mtu"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"fake": {
"type": "boolean",
"_name_": "fake",
"title": "fake",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "For BRIDGE `type` the following attribute is required: bridge_members.\nFor LINK_AGGREGATION `type` the following attributes are required: lag_ports,\nlag_protocol.\nFor VLAN `type` the following attributes are required: vlan_parent_interface,\nvlan_tag and vlan_pcp."
},
"state": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"orig_name": {
"_name_": "orig_name",
"title": "orig_name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": "integer",
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"cloned": {
"type": "boolean",
"_name_": "cloned",
"title": "cloned",
"_required_": true
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
},
"nd6_flags": {
"_name_": "nd6_flags",
"title": "nd6_flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"link_state": {
"_name_": "link_state",
"title": "link_state",
"_required_": true,
"type": "string"
},
"media_type": {
"_name_": "media_type",
"title": "media_type",
"_required_": true,
"type": "string"
},
"media_subtype": {
"_name_": "media_subtype",
"title": "media_subtype",
"_required_": true,
"type": "string"
},
"active_media_type": {
"_name_": "active_media_type",
"title": "active_media_type",
"_required_": true,
"type": "string"
},
"active_media_subtype": {
"_name_": "active_media_subtype",
"title": "active_media_subtype",
"_required_": true,
"type": "string"
},
"supported_media": {
"_name_": "supported_media",
"title": "supported_media",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"media_options": {
"_name_": "media_options",
"title": "media_options",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"link_address": {
"_name_": "link_address",
"title": "link_address",
"_required_": true,
"type": "string"
},
"permanent_link_address": {
"_name_": "permanent_link_address",
"title": "permanent_link_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"hardware_link_address": {
"_name_": "hardware_link_address",
"title": "hardware_link_address",
"_required_": true,
"type": "string"
},
"rx_queues": {
"type": "integer",
"_name_": "rx_queues",
"title": "rx_queues",
"_required_": true
},
"tx_queues": {
"type": "integer",
"_name_": "tx_queues",
"title": "tx_queues",
"_required_": true
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string"
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
},
"vrrp_config": {
"_name_": "vrrp_config",
"title": "vrrp_config",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": []
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": [
"string",
"null"
]
},
"ports": {
"_name_": "ports",
"title": "ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "lag_ports",
"title": "lag_ports",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"flags"
]
}
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"parent": {
"_name_": "parent",
"title": "parent",
"_required_": false,
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"integer",
"null"
],
"_name_": "tag",
"title": "tag",
"_required_": false
},
"pcp": {
"type": [
"integer",
"null"
],
"_name_": "pcp",
"title": "pcp",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": true,
"_attrs_order_": [
"name",
"orig_name",
"description",
"mtu",
"cloned",
"flags",
"nd6_flags",
"capabilities",
"link_state",
"media_type",
"media_subtype",
"active_media_type",
"active_media_subtype",
"supported_media",
"media_options",
"link_address",
"permanent_link_address",
"hardware_link_address",
"rx_queues",
"tx_queues",
"aliases",
"vrrp_config",
"protocol",
"ports",
"xmit_hash_policy",
"lacpdu_rate",
"parent",
"tag",
"pcp"
]
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"_required_": true
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": [
"string",
"null"
]
},
"vlan_tag": {
"type": [
"integer",
"null"
],
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string"
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "lag_port",
"title": "lag_port",
"_required_": false,
"type": "string"
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "member",
"title": "member",
"_required_": false,
"type": "string"
}
]
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "interface_create_returns",
"title": "interface_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"fake",
"type",
"state",
"aliases",
"ipv4_dhcp",
"ipv6_auto",
"description",
"mtu",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"lag_protocol",
"lag_ports",
"bridge_members",
"enable_learning"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Create virtual interfaces (Link Aggregation, VLAN) For BRIDGE For LINK_AGGREGATION For VLAN |
interface.default_route_will_be_removed |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "default_route_will_be_removed",
"title": "default_route_will_be_removed",
"_required_": false
}
|
On a fresh install of SCALE, dhclient is started for every interface so IP addresses/routes could be installed via that program. However, when the end-user goes to configure the first interface we tear down all other interfaces configs AND delete the default route. We also remove the default route if the configured gateway doesn't match the one currently installed in kernel. |
interface.delete |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "interface_id",
"title": "interface_id",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Delete Interface of |
interface.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string",
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"fake": {
"type": "boolean",
"_name_": "fake",
"title": "fake",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"state": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"orig_name": {
"_name_": "orig_name",
"title": "orig_name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": "integer",
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"cloned": {
"type": "boolean",
"_name_": "cloned",
"title": "cloned",
"_required_": true
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
},
"nd6_flags": {
"_name_": "nd6_flags",
"title": "nd6_flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"link_state": {
"_name_": "link_state",
"title": "link_state",
"_required_": true,
"type": "string"
},
"media_type": {
"_name_": "media_type",
"title": "media_type",
"_required_": true,
"type": "string"
},
"media_subtype": {
"_name_": "media_subtype",
"title": "media_subtype",
"_required_": true,
"type": "string"
},
"active_media_type": {
"_name_": "active_media_type",
"title": "active_media_type",
"_required_": true,
"type": "string"
},
"active_media_subtype": {
"_name_": "active_media_subtype",
"title": "active_media_subtype",
"_required_": true,
"type": "string"
},
"supported_media": {
"_name_": "supported_media",
"title": "supported_media",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"media_options": {
"_name_": "media_options",
"title": "media_options",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"link_address": {
"_name_": "link_address",
"title": "link_address",
"_required_": true,
"type": "string"
},
"permanent_link_address": {
"_name_": "permanent_link_address",
"title": "permanent_link_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"hardware_link_address": {
"_name_": "hardware_link_address",
"title": "hardware_link_address",
"_required_": true,
"type": "string"
},
"rx_queues": {
"type": "integer",
"_name_": "rx_queues",
"title": "rx_queues",
"_required_": true
},
"tx_queues": {
"type": "integer",
"_name_": "tx_queues",
"title": "tx_queues",
"_required_": true
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string"
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
},
"vrrp_config": {
"_name_": "vrrp_config",
"title": "vrrp_config",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": []
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": [
"string",
"null"
]
},
"ports": {
"_name_": "ports",
"title": "ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "lag_ports",
"title": "lag_ports",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"flags"
]
}
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"parent": {
"_name_": "parent",
"title": "parent",
"_required_": false,
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"integer",
"null"
],
"_name_": "tag",
"title": "tag",
"_required_": false
},
"pcp": {
"type": [
"integer",
"null"
],
"_name_": "pcp",
"title": "pcp",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": true,
"_attrs_order_": [
"name",
"orig_name",
"description",
"mtu",
"cloned",
"flags",
"nd6_flags",
"capabilities",
"link_state",
"media_type",
"media_subtype",
"active_media_type",
"active_media_subtype",
"supported_media",
"media_options",
"link_address",
"permanent_link_address",
"hardware_link_address",
"rx_queues",
"tx_queues",
"aliases",
"vrrp_config",
"protocol",
"ports",
"xmit_hash_policy",
"lacpdu_rate",
"parent",
"tag",
"pcp"
]
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"_required_": true
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": [
"string",
"null"
]
},
"vlan_tag": {
"type": [
"integer",
"null"
],
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string"
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "lag_port",
"title": "lag_port",
"_required_": false,
"type": "string"
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "member",
"title": "member",
"_required_": false,
"type": "string"
}
]
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "interface_entry",
"title": "interface_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"fake",
"type",
"state",
"aliases",
"ipv4_dhcp",
"ipv6_auto",
"description",
"mtu",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"lag_protocol",
"lag_ports",
"bridge_members",
"enable_learning"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
interface.has_pending_changes |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "has_pending_changes",
"title": "has_pending_changes",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Returns whether there are pending interfaces changes to be applied or not. |
interface.ip_in_use |
---|
Arguments:
{
"type": "object",
"properties": {
"ipv4": {
"type": "boolean",
"_name_": "ipv4",
"title": "ipv4",
"default": true,
"_required_": false
},
"ipv6": {
"type": "boolean",
"_name_": "ipv6",
"title": "ipv6",
"default": true,
"_required_": false
},
"ipv6_link_local": {
"type": "boolean",
"_name_": "ipv6_link_local",
"title": "ipv6_link_local",
"default": false,
"_required_": false
},
"loopback": {
"type": "boolean",
"_name_": "loopback",
"title": "loopback",
"default": false,
"_required_": false,
"description": "`loopback` will return loopback interface addresses."
},
"any": {
"type": "boolean",
"_name_": "any",
"title": "any",
"default": false,
"_required_": false,
"description": "`any` will return wildcard addresses (0.0.0.0 and ::)."
},
"static": {
"type": "boolean",
"_name_": "static",
"title": "static",
"default": false,
"_required_": false,
"description": "`static` when enabled will ensure we only return static ip's configured."
}
},
"additionalProperties": false,
"_name_": "ips",
"title": "ips",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipv4",
"ipv6",
"ipv6_link_local",
"loopback",
"any",
"static"
]
}
|
Return Arguments:
{
"_name_": "in_use_ips",
"title": "in_use_ips",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"type": "integer",
"_name_": "netmask",
"title": "netmask",
"_required_": true
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "in_use_ip",
"title": "in_use_ip",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
}
|
Get all IPv4 / Ipv6 from all valid interfaces, excluding tap and epair.
Returns a list of dicts - eg - [ { "type": "INET6", "address": "fe80::5054:ff:fe16:4aac", "netmask": 64 }, { "type": "INET", "address": "192.168.122.148", "netmask": 24, "broadcast": "192.168.122.255" }, ] |
interface.lacpdu_rate_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"SLOW": {
"_name_": "SLOW",
"title": "SLOW",
"_required_": false,
"type": "string",
"enum": [
"SLOW"
]
},
"FAST": {
"_name_": "FAST",
"title": "FAST",
"_required_": false,
"type": "string",
"enum": [
"FAST"
]
}
},
"additionalProperties": false,
"_name_": "lacpdu_rate_choices",
"title": "lacpdu_rate_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"SLOW",
"FAST"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Available lacpdu rate policies for the LACP lagg type interfaces. |
interface.lag_ports_choices |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "lag_ports_choices",
"title": "lag_ports_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return available interface choices that can be added to a
|
interface.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"fake": {
"type": "boolean",
"_name_": "fake",
"title": "fake",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"state": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"orig_name": {
"_name_": "orig_name",
"title": "orig_name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": "integer",
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"cloned": {
"type": "boolean",
"_name_": "cloned",
"title": "cloned",
"_required_": true
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
},
"nd6_flags": {
"_name_": "nd6_flags",
"title": "nd6_flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"link_state": {
"_name_": "link_state",
"title": "link_state",
"_required_": true,
"type": "string"
},
"media_type": {
"_name_": "media_type",
"title": "media_type",
"_required_": true,
"type": "string"
},
"media_subtype": {
"_name_": "media_subtype",
"title": "media_subtype",
"_required_": true,
"type": "string"
},
"active_media_type": {
"_name_": "active_media_type",
"title": "active_media_type",
"_required_": true,
"type": "string"
},
"active_media_subtype": {
"_name_": "active_media_subtype",
"title": "active_media_subtype",
"_required_": true,
"type": "string"
},
"supported_media": {
"_name_": "supported_media",
"title": "supported_media",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"media_options": {
"_name_": "media_options",
"title": "media_options",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"link_address": {
"_name_": "link_address",
"title": "link_address",
"_required_": true,
"type": "string"
},
"permanent_link_address": {
"_name_": "permanent_link_address",
"title": "permanent_link_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"hardware_link_address": {
"_name_": "hardware_link_address",
"title": "hardware_link_address",
"_required_": true,
"type": "string"
},
"rx_queues": {
"type": "integer",
"_name_": "rx_queues",
"title": "rx_queues",
"_required_": true
},
"tx_queues": {
"type": "integer",
"_name_": "tx_queues",
"title": "tx_queues",
"_required_": true
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string"
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
},
"vrrp_config": {
"_name_": "vrrp_config",
"title": "vrrp_config",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": []
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": [
"string",
"null"
]
},
"ports": {
"_name_": "ports",
"title": "ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "lag_ports",
"title": "lag_ports",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"flags"
]
}
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"parent": {
"_name_": "parent",
"title": "parent",
"_required_": false,
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"integer",
"null"
],
"_name_": "tag",
"title": "tag",
"_required_": false
},
"pcp": {
"type": [
"integer",
"null"
],
"_name_": "pcp",
"title": "pcp",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": true,
"_attrs_order_": [
"name",
"orig_name",
"description",
"mtu",
"cloned",
"flags",
"nd6_flags",
"capabilities",
"link_state",
"media_type",
"media_subtype",
"active_media_type",
"active_media_subtype",
"supported_media",
"media_options",
"link_address",
"permanent_link_address",
"hardware_link_address",
"rx_queues",
"tx_queues",
"aliases",
"vrrp_config",
"protocol",
"ports",
"xmit_hash_policy",
"lacpdu_rate",
"parent",
"tag",
"pcp"
]
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"_required_": true
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": [
"string",
"null"
]
},
"vlan_tag": {
"type": [
"integer",
"null"
],
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string"
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "lag_port",
"title": "lag_port",
"_required_": false,
"type": "string"
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "member",
"title": "member",
"_required_": false,
"type": "string"
}
]
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "interface_entry",
"title": "interface_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"fake",
"type",
"state",
"aliases",
"ipv4_dhcp",
"ipv6_auto",
"description",
"mtu",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"lag_protocol",
"lag_ports",
"bridge_members",
"enable_learning"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"fake": {
"type": "boolean",
"_name_": "fake",
"title": "fake",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"state": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"orig_name": {
"_name_": "orig_name",
"title": "orig_name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": "integer",
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"cloned": {
"type": "boolean",
"_name_": "cloned",
"title": "cloned",
"_required_": true
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
},
"nd6_flags": {
"_name_": "nd6_flags",
"title": "nd6_flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"link_state": {
"_name_": "link_state",
"title": "link_state",
"_required_": true,
"type": "string"
},
"media_type": {
"_name_": "media_type",
"title": "media_type",
"_required_": true,
"type": "string"
},
"media_subtype": {
"_name_": "media_subtype",
"title": "media_subtype",
"_required_": true,
"type": "string"
},
"active_media_type": {
"_name_": "active_media_type",
"title": "active_media_type",
"_required_": true,
"type": "string"
},
"active_media_subtype": {
"_name_": "active_media_subtype",
"title": "active_media_subtype",
"_required_": true,
"type": "string"
},
"supported_media": {
"_name_": "supported_media",
"title": "supported_media",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"media_options": {
"_name_": "media_options",
"title": "media_options",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"link_address": {
"_name_": "link_address",
"title": "link_address",
"_required_": true,
"type": "string"
},
"permanent_link_address": {
"_name_": "permanent_link_address",
"title": "permanent_link_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"hardware_link_address": {
"_name_": "hardware_link_address",
"title": "hardware_link_address",
"_required_": true,
"type": "string"
},
"rx_queues": {
"type": "integer",
"_name_": "rx_queues",
"title": "rx_queues",
"_required_": true
},
"tx_queues": {
"type": "integer",
"_name_": "tx_queues",
"title": "tx_queues",
"_required_": true
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string"
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
},
"vrrp_config": {
"_name_": "vrrp_config",
"title": "vrrp_config",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": []
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": [
"string",
"null"
]
},
"ports": {
"_name_": "ports",
"title": "ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "lag_ports",
"title": "lag_ports",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"flags"
]
}
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"parent": {
"_name_": "parent",
"title": "parent",
"_required_": false,
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"integer",
"null"
],
"_name_": "tag",
"title": "tag",
"_required_": false
},
"pcp": {
"type": [
"integer",
"null"
],
"_name_": "pcp",
"title": "pcp",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": true,
"_attrs_order_": [
"name",
"orig_name",
"description",
"mtu",
"cloned",
"flags",
"nd6_flags",
"capabilities",
"link_state",
"media_type",
"media_subtype",
"active_media_type",
"active_media_subtype",
"supported_media",
"media_options",
"link_address",
"permanent_link_address",
"hardware_link_address",
"rx_queues",
"tx_queues",
"aliases",
"vrrp_config",
"protocol",
"ports",
"xmit_hash_policy",
"lacpdu_rate",
"parent",
"tag",
"pcp"
]
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"_required_": true
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": [
"string",
"null"
]
},
"vlan_tag": {
"type": [
"integer",
"null"
],
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string"
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "lag_port",
"title": "lag_port",
"_required_": false,
"type": "string"
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "member",
"title": "member",
"_required_": false,
"type": "string"
}
]
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "interface_entry",
"title": "interface_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"fake",
"type",
"state",
"aliases",
"ipv4_dhcp",
"ipv6_auto",
"description",
"mtu",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"lag_protocol",
"lag_ports",
"bridge_members",
"enable_learning"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"fake": {
"type": "boolean",
"_name_": "fake",
"title": "fake",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"state": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"orig_name": {
"_name_": "orig_name",
"title": "orig_name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": "integer",
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"cloned": {
"type": "boolean",
"_name_": "cloned",
"title": "cloned",
"_required_": true
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
},
"nd6_flags": {
"_name_": "nd6_flags",
"title": "nd6_flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"link_state": {
"_name_": "link_state",
"title": "link_state",
"_required_": true,
"type": "string"
},
"media_type": {
"_name_": "media_type",
"title": "media_type",
"_required_": true,
"type": "string"
},
"media_subtype": {
"_name_": "media_subtype",
"title": "media_subtype",
"_required_": true,
"type": "string"
},
"active_media_type": {
"_name_": "active_media_type",
"title": "active_media_type",
"_required_": true,
"type": "string"
},
"active_media_subtype": {
"_name_": "active_media_subtype",
"title": "active_media_subtype",
"_required_": true,
"type": "string"
},
"supported_media": {
"_name_": "supported_media",
"title": "supported_media",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"media_options": {
"_name_": "media_options",
"title": "media_options",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"link_address": {
"_name_": "link_address",
"title": "link_address",
"_required_": true,
"type": "string"
},
"permanent_link_address": {
"_name_": "permanent_link_address",
"title": "permanent_link_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"hardware_link_address": {
"_name_": "hardware_link_address",
"title": "hardware_link_address",
"_required_": true,
"type": "string"
},
"rx_queues": {
"type": "integer",
"_name_": "rx_queues",
"title": "rx_queues",
"_required_": true
},
"tx_queues": {
"type": "integer",
"_name_": "tx_queues",
"title": "tx_queues",
"_required_": true
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string"
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
},
"vrrp_config": {
"_name_": "vrrp_config",
"title": "vrrp_config",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": []
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": [
"string",
"null"
]
},
"ports": {
"_name_": "ports",
"title": "ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "lag_ports",
"title": "lag_ports",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"flags"
]
}
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"parent": {
"_name_": "parent",
"title": "parent",
"_required_": false,
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"integer",
"null"
],
"_name_": "tag",
"title": "tag",
"_required_": false
},
"pcp": {
"type": [
"integer",
"null"
],
"_name_": "pcp",
"title": "pcp",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": true,
"_attrs_order_": [
"name",
"orig_name",
"description",
"mtu",
"cloned",
"flags",
"nd6_flags",
"capabilities",
"link_state",
"media_type",
"media_subtype",
"active_media_type",
"active_media_subtype",
"supported_media",
"media_options",
"link_address",
"permanent_link_address",
"hardware_link_address",
"rx_queues",
"tx_queues",
"aliases",
"vrrp_config",
"protocol",
"ports",
"xmit_hash_policy",
"lacpdu_rate",
"parent",
"tag",
"pcp"
]
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"_required_": true
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": [
"string",
"null"
]
},
"vlan_tag": {
"type": [
"integer",
"null"
],
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string"
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "lag_port",
"title": "lag_port",
"_required_": false,
"type": "string"
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "member",
"title": "member",
"_required_": false,
"type": "string"
}
]
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "interface_entry",
"title": "interface_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"fake",
"type",
"state",
"aliases",
"ipv4_dhcp",
"ipv6_auto",
"description",
"mtu",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"lag_protocol",
"lag_ports",
"bridge_members",
"enable_learning"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query Interfaces with |
interface.rollback |
---|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Rollback pending interfaces changes. |
interface.save_default_route |
---|
Arguments:
{
"_name_": "gw",
"title": "gw",
"_required_": true,
"type": "string"
}
|
This method exists solely to provide a "warning" and therefore a path for remediation for when an end-user modifies an interface and we rip the default gateway out from underneath them without any type of warning. NOTE: This makes 2 assumptions
1. interface.create/update/delete must have been called before
calling this method
2. this method must be called before This method exists for the predominant scenario for new users... 1. fresh install SCALE 2. all interfaces start DHCPv4 (v6 is ignored for now) 3. 1 of the interfaces receives an IP address 4. along with the IP, the kernel receives a default route (by design, of course) 5. user goes to configure this interface as having a static IP address 6. as we go through and "sync" the changes, we remove the default route because it exists in the kernel FIB but doesn't exist in the database. 7. IF the user is connecting via layer3, then they will lose all access to the TrueNAS and never be able to finalize the changes to the network because we ripped out the default route which is how they were communicating to begin with. In the above scenario, we're going to try and prevent this by doing the following: 1. fresh install SCALE 2. all interfaces start DHCPv4 3. default route is received 4. user configures an interface 5. When user pushes "Test Changes" (interface.sync), webUI will call network.configuration.default_route_will_be_removed BEFORE interface.sync 6. if network.configuration.default_route_will_be_removed returns True, then webUI will open a new modal dialog that gives the end-user ample warning/verbiage describing the situation. Furthermore, the modal will allow the user to input a default gateway 7. if user gives gateway, webUI will call this method providing the info and we'll validate accordingly 8. OR if user doesn't give gateway, they will need to "confirm" this is desired 9. the default gateway provided to us (if given by end-user) will be stored in the same in-memory cache that we use for storing the interface changes and will be rolledback accordingly in this plugin just like everything else There are a few other scenarios where this is beneficial, but the one listed above is seen most often by end-users/support team. |
interface.services_restarted_on_sync |
---|
Return Arguments:
{
"_name_": "services_to_be_restarted",
"title": "services_to_be_restarted",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"service": {
"_name_": "service",
"title": "service",
"_required_": true,
"type": "string"
},
"ips": {
"_name_": "ips",
"title": "ips",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "service_restart",
"title": "service_restart",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"service",
"ips"
]
}
]
}
|
Returns which services will be set to listen on 0.0.0.0 (and, thus, restarted) on sync. Example result: [ // Samba service will be set ot listen on 0.0.0.0 and restarted because it was set up to listen on // 192.168.0.1 which is being removed. {"type": "SYSTEM_SERVICE", "service": "cifs", "ips": ["192.168.0.1"]}, ] |
interface.update |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Update Interface of `id`."
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"default": false,
"_required_": false
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"default": false,
"_required_": false
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "INET",
"_required_": true,
"type": "string",
"enum": [
"INET",
"INET6"
]
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"type": "integer",
"_name_": "netmask",
"title": "netmask",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "interface_alias",
"title": "interface_alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"failover_critical": {
"type": "boolean",
"_name_": "failover_critical",
"title": "failover_critical",
"default": false,
"_required_": false
},
"failover_group": {
"type": [
"integer",
"null"
],
"_name_": "failover_group",
"title": "failover_group",
"_required_": false
},
"failover_vhid": {
"type": [
"integer",
"null"
],
"_name_": "failover_vhid",
"title": "failover_vhid",
"_required_": false
},
"failover_aliases": {
"_name_": "failover_aliases",
"title": "failover_aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "INET",
"_required_": true,
"type": "string",
"enum": [
"INET",
"INET6"
]
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "interface_failover_alias",
"title": "interface_failover_alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address"
]
}
]
},
"failover_virtual_aliases": {
"_name_": "failover_virtual_aliases",
"title": "failover_virtual_aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "INET",
"_required_": true,
"type": "string",
"enum": [
"INET",
"INET6"
]
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "interface_virtual_alias",
"title": "interface_virtual_alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address"
]
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"default": true,
"_required_": false
},
"stp": {
"type": "boolean",
"_name_": "stp",
"title": "stp",
"default": true,
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string",
"enum": [
"LACP",
"FAILOVER",
"LOADBALANCE",
"ROUNDROBIN",
"NONE"
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LAYER2",
"LAYER2+3",
"LAYER3+4"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"SLOW",
"FAST"
]
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "interface",
"title": "interface",
"_required_": false,
"type": "string"
}
]
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": "string"
},
"vlan_tag": {
"type": "integer",
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "interface_update",
"title": "interface_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"description",
"ipv4_dhcp",
"ipv6_auto",
"aliases",
"failover_critical",
"failover_group",
"failover_vhid",
"failover_aliases",
"failover_virtual_aliases",
"bridge_members",
"enable_learning",
"stp",
"lag_protocol",
"xmit_hash_policy",
"lacpdu_rate",
"lag_ports",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"mtu"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string",
"description": "Update Interface of `id`."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"fake": {
"type": "boolean",
"_name_": "fake",
"title": "fake",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "For BRIDGE `type` the following attribute is required: bridge_members.\nFor LINK_AGGREGATION `type` the following attributes are required: lag_ports,\nlag_protocol.\nFor VLAN `type` the following attributes are required: vlan_parent_interface,\nvlan_tag and vlan_pcp."
},
"state": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"orig_name": {
"_name_": "orig_name",
"title": "orig_name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": "integer",
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"cloned": {
"type": "boolean",
"_name_": "cloned",
"title": "cloned",
"_required_": true
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
},
"nd6_flags": {
"_name_": "nd6_flags",
"title": "nd6_flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"link_state": {
"_name_": "link_state",
"title": "link_state",
"_required_": true,
"type": "string"
},
"media_type": {
"_name_": "media_type",
"title": "media_type",
"_required_": true,
"type": "string"
},
"media_subtype": {
"_name_": "media_subtype",
"title": "media_subtype",
"_required_": true,
"type": "string"
},
"active_media_type": {
"_name_": "active_media_type",
"title": "active_media_type",
"_required_": true,
"type": "string"
},
"active_media_subtype": {
"_name_": "active_media_subtype",
"title": "active_media_subtype",
"_required_": true,
"type": "string"
},
"supported_media": {
"_name_": "supported_media",
"title": "supported_media",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"media_options": {
"_name_": "media_options",
"title": "media_options",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"link_address": {
"_name_": "link_address",
"title": "link_address",
"_required_": true,
"type": "string"
},
"permanent_link_address": {
"_name_": "permanent_link_address",
"title": "permanent_link_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"hardware_link_address": {
"_name_": "hardware_link_address",
"title": "hardware_link_address",
"_required_": true,
"type": "string"
},
"rx_queues": {
"type": "integer",
"_name_": "rx_queues",
"title": "rx_queues",
"_required_": true
},
"tx_queues": {
"type": "integer",
"_name_": "tx_queues",
"title": "tx_queues",
"_required_": true
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string"
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
},
"vrrp_config": {
"_name_": "vrrp_config",
"title": "vrrp_config",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": []
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": [
"string",
"null"
]
},
"ports": {
"_name_": "ports",
"title": "ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "lag_ports",
"title": "lag_ports",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"flags"
]
}
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"parent": {
"_name_": "parent",
"title": "parent",
"_required_": false,
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"integer",
"null"
],
"_name_": "tag",
"title": "tag",
"_required_": false
},
"pcp": {
"type": [
"integer",
"null"
],
"_name_": "pcp",
"title": "pcp",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": true,
"_attrs_order_": [
"name",
"orig_name",
"description",
"mtu",
"cloned",
"flags",
"nd6_flags",
"capabilities",
"link_state",
"media_type",
"media_subtype",
"active_media_type",
"active_media_subtype",
"supported_media",
"media_options",
"link_address",
"permanent_link_address",
"hardware_link_address",
"rx_queues",
"tx_queues",
"aliases",
"vrrp_config",
"protocol",
"ports",
"xmit_hash_policy",
"lacpdu_rate",
"parent",
"tag",
"pcp"
]
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"_required_": true
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": [
"string",
"null"
]
},
"vlan_tag": {
"type": [
"integer",
"null"
],
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string"
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "lag_port",
"title": "lag_port",
"_required_": false,
"type": "string"
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "member",
"title": "member",
"_required_": false,
"type": "string"
}
]
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "interface_update_returns",
"title": "interface_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"fake",
"type",
"state",
"aliases",
"ipv4_dhcp",
"ipv6_auto",
"description",
"mtu",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"lag_protocol",
"lag_ports",
"bridge_members",
"enable_learning"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Update Interface of |
interface.vlan_parent_interface_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "vlan_parent_interface_choices",
"title": "vlan_parent_interface_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return available interface choices for |
interface.websocket_interface |
---|
Return Arguments:
{
"_name_": "websocket_interface",
"title": "websocket_interface",
"_required_": false,
"type": [
"string",
"null"
]
}
|
Returns the interface this websocket is connected to. |
interface.websocket_local_ip |
---|
Return Arguments:
{
"_name_": "websocket_local_ip",
"title": "websocket_local_ip",
"_required_": false,
"type": [
"string",
"null"
]
}
|
Returns the local ip address for this websocket session. |
interface.xmit_hash_policy_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"LAYER2": {
"_name_": "LAYER2",
"title": "LAYER2",
"_required_": false,
"type": "string",
"enum": [
"LAYER2"
]
},
"LAYER2+3": {
"_name_": "LAYER2+3",
"title": "LAYER2+3",
"_required_": false,
"type": "string",
"enum": [
"LAYER2+3"
]
},
"LAYER3+4": {
"_name_": "LAYER3+4",
"title": "LAYER3+4",
"_required_": false,
"type": "string",
"enum": [
"LAYER3+4"
]
}
},
"additionalProperties": false,
"_name_": "xmit_hash_policy_choices",
"title": "xmit_hash_policy_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"LAYER2",
"LAYER2+3",
"LAYER3+4"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Available transmit hash policies for the LACP or LOADBALANCE lagg type interfaces. |
interface.capabilities.get |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"_name_": "enabled",
"title": "enabled",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "capability",
"title": "capability",
"_required_": false,
"type": "string"
}
]
},
"disabled": {
"_name_": "disabled",
"title": "disabled",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "capability",
"title": "capability",
"_required_": false,
"type": "string"
}
]
},
"supported": {
"_name_": "supported",
"title": "supported",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "capability",
"title": "capability",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "capabilties",
"title": "capabilties",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"disabled",
"supported"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_READ, NETWORK_INTERFACE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return enabled, disabled and supported capabilities (also known as features) on a given interface.
|
interface.capabilities.set |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` String representing name of the interface\n`capabilities` List representing capabilities to be acted upon"
},
"capabilties": {
"_name_": "capabilties",
"title": "capabilties",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"action": {
"_name_": "action",
"title": "action",
"_required_": true,
"type": "string",
"enum": [
"ENABLE",
"DISABLE"
]
}
},
"additionalProperties": false,
"_name_": "capabilities_set",
"title": "capabilities_set",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"capabilties",
"action"
]
}
|
Return Arguments:
{
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "capability",
"title": "capability",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_INTERFACE_WRITE |
Enable or Disable capabilties (also known as features) on a given interface.
|
ipmi.is_loaded |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "ipmi_loaded",
"title": "ipmi_loaded",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns a boolean value indicating if /dev/ipmi0 is loaded. |
ipmi.chassis.identify |
---|
Arguments:
{
"_name_": "verb",
"title": "verb",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"ON",
"OFF"
]
}
|
This method is accessible to the users granted with the following roles: IPMI_WRITE |
Toggle the chassis identify light.
|
ipmi.chassis.info |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "chassis_info",
"title": "chassis_info",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: IPMI_READ, IPMI_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return looks like: { "system_power": "on", "power_overload": "false", "interlock": "inactive", "power_fault": "false", "power_control_fault": "false", "power_restore_policy": "Always off", "last_power_event": "unknown", "chassis_intrusion": "inactive", "front_panel_lockout": "inactive", "drive_fault": "false", "cooling/fan_fault": "false", "chassis_identify_state": "off" } |
ipmi.lan.channels |
---|
Return Arguments:
{
"_name_": "lan_channels",
"title": "lan_channels",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "lan_channel",
"title": "lan_channel",
"_required_": false
}
]
}
|
This method is accessible to the users granted with the following roles: IPMI_READ, IPMI_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return a list of available IPMI channels. |
ipmi.lan.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"channel": {
"type": "integer",
"_name_": "channel",
"title": "channel",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"ip_address_source": {
"_name_": "ip_address_source",
"title": "ip_address_source",
"_required_": false,
"type": "string"
},
"ip_address": {
"_name_": "ip_address",
"title": "ip_address",
"_required_": false,
"type": "string"
},
"mac_address": {
"_name_": "mac_address",
"title": "mac_address",
"_required_": false,
"type": "string"
},
"subnet_mask": {
"_name_": "subnet_mask",
"title": "subnet_mask",
"_required_": false,
"type": "string"
},
"default_gateway_ip_address": {
"_name_": "default_gateway_ip_address",
"title": "default_gateway_ip_address",
"_required_": false,
"type": "string"
},
"default_gateway_mac_address": {
"_name_": "default_gateway_mac_address",
"title": "default_gateway_mac_address",
"_required_": false,
"type": "string"
},
"backup_gateway_ip_address": {
"_name_": "backup_gateway_ip_address",
"title": "backup_gateway_ip_address",
"_required_": false,
"type": "string"
},
"backup_gateway_mac_address": {
"_name_": "backup_gateway_mac_address",
"title": "backup_gateway_mac_address",
"_required_": false,
"type": "string"
},
"vlan_id": {
"type": "integer",
"_name_": "vlan_id",
"title": "vlan_id",
"_required_": false
},
"vlan_id_enable": {
"type": "boolean",
"_name_": "vlan_id_enable",
"title": "vlan_id_enable",
"_required_": false
},
"vlan_priority": {
"type": "integer",
"_name_": "vlan_priority",
"title": "vlan_priority",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi_channel",
"title": "ipmi_channel",
"default": {},
"_required_": false,
"_attrs_order_": [
"channel",
"id",
"ip_address_source",
"ip_address",
"mac_address",
"subnet_mask",
"default_gateway_ip_address",
"default_gateway_mac_address",
"backup_gateway_ip_address",
"backup_gateway_mac_address",
"vlan_id",
"vlan_id_enable",
"vlan_priority"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
ipmi.lan.query |
---|
Arguments:
{
"type": "object",
"properties": {
"query-filters": {
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
},
"query-options": {
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
},
"ipmi-options": {
"type": "object",
"properties": {
"query-remote": {
"type": "boolean",
"_name_": "query-remote",
"title": "query-remote",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi-options",
"title": "ipmi-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"query-remote"
]
}
},
"additionalProperties": false,
"_name_": "ipmi_lan_query",
"title": "ipmi_lan_query",
"default": {},
"_required_": false,
"_attrs_order_": [
"query-filters",
"query-options",
"ipmi-options"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"channel": {
"type": "integer",
"_name_": "channel",
"title": "channel",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ip_address_source": {
"_name_": "ip_address_source",
"title": "ip_address_source",
"_required_": false,
"type": "string"
},
"ip_address": {
"_name_": "ip_address",
"title": "ip_address",
"_required_": false,
"type": "string"
},
"mac_address": {
"_name_": "mac_address",
"title": "mac_address",
"_required_": false,
"type": "string"
},
"subnet_mask": {
"_name_": "subnet_mask",
"title": "subnet_mask",
"_required_": false,
"type": "string"
},
"default_gateway_ip_address": {
"_name_": "default_gateway_ip_address",
"title": "default_gateway_ip_address",
"_required_": false,
"type": "string"
},
"default_gateway_mac_address": {
"_name_": "default_gateway_mac_address",
"title": "default_gateway_mac_address",
"_required_": false,
"type": "string"
},
"backup_gateway_ip_address": {
"_name_": "backup_gateway_ip_address",
"title": "backup_gateway_ip_address",
"_required_": false,
"type": "string"
},
"backup_gateway_mac_address": {
"_name_": "backup_gateway_mac_address",
"title": "backup_gateway_mac_address",
"_required_": false,
"type": "string"
},
"vlan_id": {
"type": "integer",
"_name_": "vlan_id",
"title": "vlan_id",
"_required_": false
},
"vlan_id_enable": {
"type": "boolean",
"_name_": "vlan_id_enable",
"title": "vlan_id_enable",
"_required_": false
},
"vlan_priority": {
"type": "integer",
"_name_": "vlan_priority",
"title": "vlan_priority",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi_channel",
"title": "ipmi_channel",
"default": {},
"_required_": false,
"_attrs_order_": [
"channel",
"id",
"ip_address_source",
"ip_address",
"mac_address",
"subnet_mask",
"default_gateway_ip_address",
"default_gateway_mac_address",
"backup_gateway_ip_address",
"backup_gateway_mac_address",
"vlan_id",
"vlan_id_enable",
"vlan_priority"
]
}
]
},
{
"type": "object",
"properties": {
"channel": {
"type": "integer",
"_name_": "channel",
"title": "channel",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ip_address_source": {
"_name_": "ip_address_source",
"title": "ip_address_source",
"_required_": false,
"type": "string"
},
"ip_address": {
"_name_": "ip_address",
"title": "ip_address",
"_required_": false,
"type": "string"
},
"mac_address": {
"_name_": "mac_address",
"title": "mac_address",
"_required_": false,
"type": "string"
},
"subnet_mask": {
"_name_": "subnet_mask",
"title": "subnet_mask",
"_required_": false,
"type": "string"
},
"default_gateway_ip_address": {
"_name_": "default_gateway_ip_address",
"title": "default_gateway_ip_address",
"_required_": false,
"type": "string"
},
"default_gateway_mac_address": {
"_name_": "default_gateway_mac_address",
"title": "default_gateway_mac_address",
"_required_": false,
"type": "string"
},
"backup_gateway_ip_address": {
"_name_": "backup_gateway_ip_address",
"title": "backup_gateway_ip_address",
"_required_": false,
"type": "string"
},
"backup_gateway_mac_address": {
"_name_": "backup_gateway_mac_address",
"title": "backup_gateway_mac_address",
"_required_": false,
"type": "string"
},
"vlan_id": {
"type": "integer",
"_name_": "vlan_id",
"title": "vlan_id",
"_required_": false
},
"vlan_id_enable": {
"type": "boolean",
"_name_": "vlan_id_enable",
"title": "vlan_id_enable",
"_required_": false
},
"vlan_priority": {
"type": "integer",
"_name_": "vlan_priority",
"title": "vlan_priority",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi_channel",
"title": "ipmi_channel",
"default": {},
"_required_": false,
"_attrs_order_": [
"channel",
"id",
"ip_address_source",
"ip_address",
"mac_address",
"subnet_mask",
"default_gateway_ip_address",
"default_gateway_mac_address",
"backup_gateway_ip_address",
"backup_gateway_mac_address",
"vlan_id",
"vlan_id_enable",
"vlan_priority"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"channel": {
"type": "integer",
"_name_": "channel",
"title": "channel",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ip_address_source": {
"_name_": "ip_address_source",
"title": "ip_address_source",
"_required_": false,
"type": "string"
},
"ip_address": {
"_name_": "ip_address",
"title": "ip_address",
"_required_": false,
"type": "string"
},
"mac_address": {
"_name_": "mac_address",
"title": "mac_address",
"_required_": false,
"type": "string"
},
"subnet_mask": {
"_name_": "subnet_mask",
"title": "subnet_mask",
"_required_": false,
"type": "string"
},
"default_gateway_ip_address": {
"_name_": "default_gateway_ip_address",
"title": "default_gateway_ip_address",
"_required_": false,
"type": "string"
},
"default_gateway_mac_address": {
"_name_": "default_gateway_mac_address",
"title": "default_gateway_mac_address",
"_required_": false,
"type": "string"
},
"backup_gateway_ip_address": {
"_name_": "backup_gateway_ip_address",
"title": "backup_gateway_ip_address",
"_required_": false,
"type": "string"
},
"backup_gateway_mac_address": {
"_name_": "backup_gateway_mac_address",
"title": "backup_gateway_mac_address",
"_required_": false,
"type": "string"
},
"vlan_id": {
"type": "integer",
"_name_": "vlan_id",
"title": "vlan_id",
"_required_": false
},
"vlan_id_enable": {
"type": "boolean",
"_name_": "vlan_id_enable",
"title": "vlan_id_enable",
"_required_": false
},
"vlan_priority": {
"type": "integer",
"_name_": "vlan_priority",
"title": "vlan_priority",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi_channel",
"title": "ipmi_channel",
"default": {},
"_required_": false,
"_attrs_order_": [
"channel",
"id",
"ip_address_source",
"ip_address",
"mac_address",
"subnet_mask",
"default_gateway_ip_address",
"default_gateway_mac_address",
"backup_gateway_ip_address",
"backup_gateway_mac_address",
"vlan_id",
"vlan_id_enable",
"vlan_priority"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: IPMI_READ, IPMI_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query available IPMI Channels with |
ipmi.lan.update |
---|
Arguments:
{
"type": "integer",
"_name_": "channel",
"title": "channel",
"_required_": false
}
{
"type": "object",
"properties": {
"ipaddress": {
"_name_": "ipaddress",
"title": "ipaddress",
"_required_": false,
"type": "string",
"description": "`ipaddress` is an IPv4 address to be assigned to channel number `id`.\n`netmask` is the subnet mask associated with `ipaddress`.\n`gateway` is an IPv4 address used by `ipaddress` to reach outside the local subnet.\n`dhcp` is a boolean. If False, `ipaddress`, `netmask` and `gateway` must be set."
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string",
"description": "`ipaddress` is an IPv4 address to be assigned to channel number `id`.\n`netmask` is the subnet mask associated with `ipaddress`.\n`gateway` is an IPv4 address used by `ipaddress` to reach outside the local subnet.\n`dhcp` is a boolean. If False, `ipaddress`, `netmask` and `gateway` must be set."
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": false,
"type": "string",
"description": "`ipaddress` is an IPv4 address to be assigned to channel number `id`.\n`netmask` is the subnet mask associated with `ipaddress`.\n`gateway` is an IPv4 address used by `ipaddress` to reach outside the local subnet.\n`dhcp` is a boolean. If False, `ipaddress`, `netmask` and `gateway` must be set."
},
"password": {
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string",
"description": "`password` is a password to be assigned to channel number `id`"
},
"dhcp": {
"type": "boolean",
"_name_": "dhcp",
"title": "dhcp",
"_required_": false,
"description": "`dhcp` is a boolean. If False, `ipaddress`, `netmask` and `gateway` must be set."
},
"vlan": {
"type": [
"integer",
"null"
],
"_name_": "vlan",
"title": "vlan",
"_required_": false,
"description": "`vlan` is an integer representing the vlan tag number."
},
"apply_remote": {
"type": "boolean",
"_name_": "apply_remote",
"title": "apply_remote",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi_update",
"title": "ipmi_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipaddress",
"netmask",
"gateway",
"password",
"dhcp",
"vlan",
"apply_remote"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"channel": {
"type": "integer",
"_name_": "channel",
"title": "channel",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update IPMI configuration on channel number `id`."
},
"ip_address_source": {
"_name_": "ip_address_source",
"title": "ip_address_source",
"_required_": false,
"type": "string"
},
"ip_address": {
"_name_": "ip_address",
"title": "ip_address",
"_required_": false,
"type": "string"
},
"mac_address": {
"_name_": "mac_address",
"title": "mac_address",
"_required_": false,
"type": "string"
},
"subnet_mask": {
"_name_": "subnet_mask",
"title": "subnet_mask",
"_required_": false,
"type": "string"
},
"default_gateway_ip_address": {
"_name_": "default_gateway_ip_address",
"title": "default_gateway_ip_address",
"_required_": false,
"type": "string"
},
"default_gateway_mac_address": {
"_name_": "default_gateway_mac_address",
"title": "default_gateway_mac_address",
"_required_": false,
"type": "string"
},
"backup_gateway_ip_address": {
"_name_": "backup_gateway_ip_address",
"title": "backup_gateway_ip_address",
"_required_": false,
"type": "string"
},
"backup_gateway_mac_address": {
"_name_": "backup_gateway_mac_address",
"title": "backup_gateway_mac_address",
"_required_": false,
"type": "string"
},
"vlan_id": {
"type": "integer",
"_name_": "vlan_id",
"title": "vlan_id",
"_required_": false
},
"vlan_id_enable": {
"type": "boolean",
"_name_": "vlan_id_enable",
"title": "vlan_id_enable",
"_required_": false
},
"vlan_priority": {
"type": "integer",
"_name_": "vlan_priority",
"title": "vlan_priority",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi_lan_update_returns",
"title": "ipmi_lan_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"channel",
"id",
"ip_address_source",
"ip_address",
"mac_address",
"subnet_mask",
"default_gateway_ip_address",
"default_gateway_mac_address",
"backup_gateway_ip_address",
"backup_gateway_mac_address",
"vlan_id",
"vlan_id_enable",
"vlan_priority"
]
}
|
This method is accessible to the users granted with the following roles: IPMI_WRITE |
Update IPMI configuration on channel number
|
ipmi.mc.info |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "mc_info",
"title": "mc_info",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: IPMI_READ, IPMI_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return looks like: { 'auxiliary_firmware_revision_information': '00000006h', 'bridge': 'unsupported', 'chassis_device': 'supported', 'device_available': 'yes (normal operation)', 'device_id': '32', 'device_revision': '1', 'device_sdrs': 'unsupported', 'firmware_revision': '6.71', 'fru_inventory_device': 'supported', 'ipmb_event_generator': 'supported', 'ipmb_event_receiver': 'supported', 'ipmi_version': '2.0', 'manufacturer_id': 'Super Micro Computer Inc. (10876)', 'product_id': '2327', 'sdr_repository_device': 'supported', 'sel_device': 'supported', 'sensor_device': 'supported' } |
ipmi.sel.clear
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
This method is accessible to the users granted with the following roles: IPMI_WRITE |
- |
ipmi.sel.elist
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipmi_elist",
"title": "ipmi_elist",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipmi_elist",
"title": "ipmi_elist",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: IPMI_READ, IPMI_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query IPMI System Event Log (SEL) extended list |
ipmi.sel.info
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipmi_sel_info",
"title": "ipmi_sel_info",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: IPMI_READ, IPMI_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query General information about the IPMI System Event Log |
ipmi.sensors.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"_name_": "sensors",
"title": "sensors",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sensor",
"title": "sensor",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "sensors",
"title": "sensors",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sensor",
"title": "sensor",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: IPMI_READ, IPMI_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
iscsi.auth.create |
---|
Arguments:
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true,
"description": "`tag` should be unique among all configured iSCSI Authorized Accesses."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_create",
"title": "iscsi_auth_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true,
"description": "`tag` should be unique among all configured iSCSI Authorized Accesses."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_create_returns",
"title": "iscsi_auth_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret",
"id"
]
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_AUTH_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Create an iSCSI Authorized Access.
|
iscsi.auth.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_AUTH_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Delete iSCSI Authorized Access of |
iscsi.auth.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string"
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_entry",
"title": "iscsi_auth_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_AUTH_READ, SHARING_ISCSI_AUTH_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
iscsi.auth.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string"
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_entry",
"title": "iscsi_auth_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string"
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_entry",
"title": "iscsi_auth_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string"
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_entry",
"title": "iscsi_auth_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_AUTH_READ, SHARING_ISCSI_AUTH_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.auth.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update iSCSI Authorized Access of `id`.\nCreate an iSCSI Authorized Access."
}
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true,
"description": "`tag` should be unique among all configured iSCSI Authorized Accesses."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_update",
"title": "iscsi_auth_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true,
"description": "`tag` should be unique among all configured iSCSI Authorized Accesses."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string",
"description": "`secret` and `peersecret` should have length between 12-16 letters inclusive."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update iSCSI Authorized Access of `id`.\nCreate an iSCSI Authorized Access."
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_update_returns",
"title": "iscsi_auth_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret",
"id"
]
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_AUTH_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update iSCSI Authorized Access of |
iscsi.extent.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "DISK",
"_required_": false,
"type": "string",
"enum": [
"DISK",
"FILE"
],
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE.\nWith `type` being set to DISK, a valid ZFS volume is required."
},
"disk": {
"_name_": "disk",
"title": "disk",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"serial": {
"_name_": "serial",
"title": "serial",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"path": {
"_name_": "path",
"title": "path",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE."
},
"filesize": {
"type": "integer",
"_name_": "filesize",
"title": "filesize",
"default": 0,
"_required_": false,
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE."
},
"blocksize": {
"type": "integer",
"_name_": "blocksize",
"title": "blocksize",
"default": 512,
"_required_": false,
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE."
},
"pblocksize": {
"type": "boolean",
"_name_": "pblocksize",
"title": "pblocksize",
"_required_": false
},
"avail_threshold": {
"type": [
"integer",
"null"
],
"_name_": "avail_threshold",
"title": "avail_threshold",
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"insecure_tpc": {
"type": "boolean",
"_name_": "insecure_tpc",
"title": "insecure_tpc",
"default": true,
"_required_": false,
"description": "`insecure_tpc` when enabled allows an initiator to bypass normal access control and access any scannable\ntarget. This allows xcopy operations otherwise blocked by access control."
},
"xen": {
"type": "boolean",
"_name_": "xen",
"title": "xen",
"_required_": false,
"description": "`xen` is a boolean value which is set to true if Xen is being used as the iSCSI initiator."
},
"rpm": {
"_name_": "rpm",
"title": "rpm",
"default": "SSD",
"_required_": false,
"type": "string",
"enum": [
"UNKNOWN",
"SSD",
"5400",
"7200",
"10000",
"15000"
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "iscsi_extent_create",
"title": "iscsi_extent_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"disk",
"serial",
"path",
"filesize",
"blocksize",
"pblocksize",
"avail_threshold",
"comment",
"insecure_tpc",
"xen",
"rpm",
"ro",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_extent_create_returns",
"title": "iscsi_extent_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_EXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Create an iSCSI Extent. When With
|
iscsi.extent.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete iSCSI Extent of `id`."
}
{
"type": "boolean",
"_name_": "remove",
"title": "remove",
"default": false,
"_required_": false
}
{
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_EXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Delete iSCSI Extent of If |
iscsi.extent.disk_choices |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_EXTENT_READ, SHARING_ISCSI_EXTENT_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Return a dict of available zvols that can be used when creating an extent. |
iscsi.extent.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_extent_entry",
"title": "iscsi_extent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_EXTENT_READ, SHARING_ISCSI_EXTENT_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
iscsi.extent.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_extent_entry",
"title": "iscsi_extent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_extent_entry",
"title": "iscsi_extent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_extent_entry",
"title": "iscsi_extent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_EXTENT_READ, SHARING_ISCSI_EXTENT_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.extent.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update iSCSI Extent of `id`.\nCreate an iSCSI Extent."
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "DISK",
"_required_": false,
"type": "string",
"enum": [
"DISK",
"FILE"
],
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE.\nWith `type` being set to DISK, a valid ZFS volume is required."
},
"disk": {
"_name_": "disk",
"title": "disk",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"serial": {
"_name_": "serial",
"title": "serial",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"path": {
"_name_": "path",
"title": "path",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE."
},
"filesize": {
"type": "integer",
"_name_": "filesize",
"title": "filesize",
"default": 0,
"_required_": false,
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE."
},
"blocksize": {
"type": "integer",
"_name_": "blocksize",
"title": "blocksize",
"default": 512,
"_required_": false,
"description": "When `type` is set to FILE, attribute `filesize` is used and it represents number of bytes. `filesize` if\nnot zero should be a multiple of `blocksize`. `path` is a required attribute with `type` set as FILE."
},
"pblocksize": {
"type": "boolean",
"_name_": "pblocksize",
"title": "pblocksize",
"_required_": false
},
"avail_threshold": {
"type": [
"integer",
"null"
],
"_name_": "avail_threshold",
"title": "avail_threshold",
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"insecure_tpc": {
"type": "boolean",
"_name_": "insecure_tpc",
"title": "insecure_tpc",
"default": true,
"_required_": false,
"description": "`insecure_tpc` when enabled allows an initiator to bypass normal access control and access any scannable\ntarget. This allows xcopy operations otherwise blocked by access control."
},
"xen": {
"type": "boolean",
"_name_": "xen",
"title": "xen",
"_required_": false,
"description": "`xen` is a boolean value which is set to true if Xen is being used as the iSCSI initiator."
},
"rpm": {
"_name_": "rpm",
"title": "rpm",
"default": "SSD",
"_required_": false,
"type": "string",
"enum": [
"UNKNOWN",
"SSD",
"5400",
"7200",
"10000",
"15000"
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "iscsi_extent_update",
"title": "iscsi_extent_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"disk",
"serial",
"path",
"filesize",
"blocksize",
"pblocksize",
"avail_threshold",
"comment",
"insecure_tpc",
"xen",
"rpm",
"ro",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_extent_update_returns",
"title": "iscsi_extent_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_EXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update iSCSI Extent of |
iscsi.global.alua_enabled |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_GLOBAL_READ, SHARING_ISCSI_GLOBAL_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns whether iSCSI ALUA is enabled or not. |
iscsi.global.client_count |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_GLOBAL_READ, SHARING_ISCSI_GLOBAL_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Return currently connected clients count. |
iscsi.global.config |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_global_entry",
"title": "iscsi_global_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_GLOBAL_READ, SHARING_ISCSI_GLOBAL_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.global.sessions |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"initiator": {
"_name_": "initiator",
"title": "initiator",
"_required_": false,
"type": "string"
},
"initiator_addr": {
"_name_": "initiator_addr",
"title": "initiator_addr",
"_required_": false,
"type": "string"
},
"initiator_alias": {
"_name_": "initiator_alias",
"title": "initiator_alias",
"_required_": false,
"type": [
"string",
"null"
]
},
"target": {
"_name_": "target",
"title": "target",
"_required_": false,
"type": "string"
},
"target_alias": {
"_name_": "target_alias",
"title": "target_alias",
"_required_": false,
"type": "string"
},
"header_digest": {
"_name_": "header_digest",
"title": "header_digest",
"_required_": false,
"type": [
"string",
"null"
]
},
"data_digest": {
"_name_": "data_digest",
"title": "data_digest",
"_required_": false,
"type": [
"string",
"null"
]
},
"max_data_segment_length": {
"type": [
"integer",
"null"
],
"_name_": "max_data_segment_length",
"title": "max_data_segment_length",
"_required_": false
},
"max_receive_data_segment_length": {
"type": [
"integer",
"null"
],
"_name_": "max_receive_data_segment_length",
"title": "max_receive_data_segment_length",
"_required_": false
},
"max_burst_length": {
"type": [
"integer",
"null"
],
"_name_": "max_burst_length",
"title": "max_burst_length",
"_required_": false
},
"first_burst_length": {
"type": [
"integer",
"null"
],
"_name_": "first_burst_length",
"title": "first_burst_length",
"_required_": false
},
"immediate_data": {
"type": "boolean",
"_name_": "immediate_data",
"title": "immediate_data",
"_required_": false
},
"iser": {
"type": "boolean",
"_name_": "iser",
"title": "iser",
"_required_": false
},
"offload": {
"type": "boolean",
"_name_": "offload",
"title": "offload",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "session",
"title": "session",
"default": {},
"_required_": false,
"_attrs_order_": [
"initiator",
"initiator_addr",
"initiator_alias",
"target",
"target_alias",
"header_digest",
"data_digest",
"max_data_segment_length",
"max_receive_data_segment_length",
"max_burst_length",
"first_burst_length",
"immediate_data",
"iser",
"offload"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"initiator": {
"_name_": "initiator",
"title": "initiator",
"_required_": false,
"type": "string"
},
"initiator_addr": {
"_name_": "initiator_addr",
"title": "initiator_addr",
"_required_": false,
"type": "string"
},
"initiator_alias": {
"_name_": "initiator_alias",
"title": "initiator_alias",
"_required_": false,
"type": [
"string",
"null"
]
},
"target": {
"_name_": "target",
"title": "target",
"_required_": false,
"type": "string"
},
"target_alias": {
"_name_": "target_alias",
"title": "target_alias",
"_required_": false,
"type": "string"
},
"header_digest": {
"_name_": "header_digest",
"title": "header_digest",
"_required_": false,
"type": [
"string",
"null"
]
},
"data_digest": {
"_name_": "data_digest",
"title": "data_digest",
"_required_": false,
"type": [
"string",
"null"
]
},
"max_data_segment_length": {
"type": [
"integer",
"null"
],
"_name_": "max_data_segment_length",
"title": "max_data_segment_length",
"_required_": false
},
"max_receive_data_segment_length": {
"type": [
"integer",
"null"
],
"_name_": "max_receive_data_segment_length",
"title": "max_receive_data_segment_length",
"_required_": false
},
"max_burst_length": {
"type": [
"integer",
"null"
],
"_name_": "max_burst_length",
"title": "max_burst_length",
"_required_": false
},
"first_burst_length": {
"type": [
"integer",
"null"
],
"_name_": "first_burst_length",
"title": "first_burst_length",
"_required_": false
},
"immediate_data": {
"type": "boolean",
"_name_": "immediate_data",
"title": "immediate_data",
"_required_": false
},
"iser": {
"type": "boolean",
"_name_": "iser",
"title": "iser",
"_required_": false
},
"offload": {
"type": "boolean",
"_name_": "offload",
"title": "offload",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "session",
"title": "session",
"default": {},
"_required_": false,
"_attrs_order_": [
"initiator",
"initiator_addr",
"initiator_alias",
"target",
"target_alias",
"header_digest",
"data_digest",
"max_data_segment_length",
"max_receive_data_segment_length",
"max_burst_length",
"first_burst_length",
"immediate_data",
"iser",
"offload"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_GLOBAL_READ, SHARING_ISCSI_GLOBAL_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Get a list of currently running iSCSI sessions. This includes initiator and target names and the unique connection IDs. |
iscsi.global.update |
---|
Arguments:
{
"type": "object",
"properties": {
"basename": {
"_name_": "basename",
"title": "basename",
"_required_": false,
"type": "string"
},
"isns_servers": {
"_name_": "isns_servers",
"title": "isns_servers",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "server",
"title": "server",
"_required_": false,
"type": "string"
}
]
},
"listen_port": {
"type": "integer",
"_name_": "listen_port",
"title": "listen_port",
"default": 3260,
"_required_": false
},
"pool_avail_threshold": {
"type": [
"integer",
"null"
],
"_name_": "pool_avail_threshold",
"title": "pool_avail_threshold",
"_required_": false
},
"alua": {
"type": "boolean",
"_name_": "alua",
"title": "alua",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "iscsiglobal_update",
"title": "iscsiglobal_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"basename",
"isns_servers",
"listen_port",
"pool_avail_threshold",
"alua"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_global_update_returns",
"title": "iscsi_global_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_GLOBAL_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
|
iscsi.host.create |
---|
Arguments:
{
"type": "object",
"properties": {
"ip": {
"_name_": "ip",
"title": "ip",
"_required_": true,
"type": "string",
"description": "`ip` indicates an IP address of the host."
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string",
"description": "`description` is a human-readable name for the host."
},
"iqns": {
"_name_": "iqns",
"title": "iqns",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "iqn",
"title": "iqn",
"_required_": false,
"type": "string"
}
]
},
"added_automatically": {
"type": "boolean",
"_name_": "added_automatically",
"title": "added_automatically",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "iscsi_host_create",
"title": "iscsi_host_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"ip",
"description",
"iqns",
"added_automatically"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_host_create_returns",
"title": "iscsi_host_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Creates iSCSI host.
|
iscsi.host.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update iSCSI host |
iscsi.host.get_initiators |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_HOST_READ, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns initiator groups associated with host |
iscsi.host.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_host_entry",
"title": "iscsi_host_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_HOST_READ, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
iscsi.host.get_targets |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_HOST_READ, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns targets associated with host |
iscsi.host.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_host_entry",
"title": "iscsi_host_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_host_entry",
"title": "iscsi_host_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_host_entry",
"title": "iscsi_host_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_HOST_READ, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.host.set_initiators |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Associates initiator groups `ids` with host `id`."
}
{
"_name_": "ids",
"title": "ids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
],
"description": "Associates initiator groups `ids` with host `id`."
}
{
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Associates initiator groups |
iscsi.host.set_targets |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"_name_": "ids",
"title": "ids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Associates targets |
iscsi.host.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update iSCSI host `id`.\nCreates iSCSI host."
}
{
"type": "object",
"properties": {
"ip": {
"_name_": "ip",
"title": "ip",
"_required_": true,
"type": "string",
"description": "`ip` indicates an IP address of the host."
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string",
"description": "`description` is a human-readable name for the host."
},
"iqns": {
"_name_": "iqns",
"title": "iqns",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "iqn",
"title": "iqn",
"_required_": false,
"type": "string"
}
]
},
"added_automatically": {
"type": "boolean",
"_name_": "added_automatically",
"title": "added_automatically",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "iscsi_host_update",
"title": "iscsi_host_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"ip",
"description",
"iqns",
"added_automatically"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_host_update_returns",
"title": "iscsi_host_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_HOST_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update iSCSI host |
iscsi.initiator.create |
---|
Arguments:
{
"type": "object",
"properties": {
"initiators": {
"_name_": "initiators",
"title": "initiators",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "iscsi_initiator_create",
"title": "iscsi_initiator_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"initiators",
"comment"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_initiator_create_returns",
"title": "iscsi_initiator_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_INITIATOR_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Create an iSCSI Initiator.
|
iscsi.initiator.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_INITIATOR_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Delete iSCSI initiator of |
iscsi.initiator.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_initiator_entry",
"title": "iscsi_initiator_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_INITIATOR_READ, SHARING_ISCSI_INITIATOR_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
iscsi.initiator.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_initiator_entry",
"title": "iscsi_initiator_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_initiator_entry",
"title": "iscsi_initiator_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_initiator_entry",
"title": "iscsi_initiator_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_INITIATOR_READ, SHARING_ISCSI_INITIATOR_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.initiator.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update iSCSI initiator of `id`.\nCreate an iSCSI Initiator."
}
{
"type": "object",
"properties": {
"initiators": {
"_name_": "initiators",
"title": "initiators",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "iscsi_initiator_update",
"title": "iscsi_initiator_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"initiators",
"comment"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_initiator_update_returns",
"title": "iscsi_initiator_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_INITIATOR_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update iSCSI initiator of |
iscsi.portal.create |
---|
Arguments:
{
"type": "object",
"properties": {
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"discovery_authmethod": {
"_name_": "discovery_authmethod",
"title": "discovery_authmethod",
"default": "NONE",
"_required_": false,
"type": "string",
"enum": [
"NONE",
"CHAP",
"CHAP_MUTUAL"
]
},
"discovery_authgroup": {
"type": [
"integer",
"null"
],
"_name_": "discovery_authgroup",
"title": "discovery_authgroup",
"default": null,
"_required_": false
},
"listen": {
"_name_": "listen",
"title": "listen",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ip": {
"_name_": "ip",
"title": "ip",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "listen",
"title": "listen",
"default": {},
"_required_": false,
"_attrs_order_": [
"ip"
]
}
]
}
},
"additionalProperties": false,
"_name_": "iscsiportal_create",
"title": "iscsiportal_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"comment",
"discovery_authmethod",
"discovery_authgroup",
"listen"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_portal_create_returns",
"title": "iscsi_portal_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_PORTAL_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Create a new iSCSI Portal.
|
iscsi.portal.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_PORTAL_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Delete iSCSI Portal |
iscsi.portal.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_portal_entry",
"title": "iscsi_portal_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_PORTAL_READ, SHARING_ISCSI_PORTAL_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
iscsi.portal.listen_ip_choices |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_PORTAL_READ, SHARING_ISCSI_PORTAL_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns possible choices for |
iscsi.portal.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_portal_entry",
"title": "iscsi_portal_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_portal_entry",
"title": "iscsi_portal_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_portal_entry",
"title": "iscsi_portal_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_PORTAL_READ, SHARING_ISCSI_PORTAL_WRITE, SHARING_ISCSI_READ, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.portal.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update iSCSI Portal `id`.\nCreate a new iSCSI Portal."
}
{
"type": "object",
"properties": {
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"discovery_authmethod": {
"_name_": "discovery_authmethod",
"title": "discovery_authmethod",
"default": "NONE",
"_required_": false,
"type": "string",
"enum": [
"NONE",
"CHAP",
"CHAP_MUTUAL"
]
},
"discovery_authgroup": {
"type": [
"integer",
"null"
],
"_name_": "discovery_authgroup",
"title": "discovery_authgroup",
"default": null,
"_required_": false
},
"listen": {
"_name_": "listen",
"title": "listen",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ip": {
"_name_": "ip",
"title": "ip",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "listen",
"title": "listen",
"default": {},
"_required_": false,
"_attrs_order_": [
"ip"
]
}
]
}
},
"additionalProperties": false,
"_name_": "iscsiportal_update",
"title": "iscsiportal_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"comment",
"discovery_authmethod",
"discovery_authgroup",
"listen"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_portal_update_returns",
"title": "iscsi_portal_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_PORTAL_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update iSCSI Portal |
iscsi.target.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"alias": {
"_name_": "alias",
"title": "alias",
"_required_": false,
"type": [
"string",
"null"
]
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "ISCSI",
"_required_": false,
"type": "string",
"enum": [
"ISCSI",
"FC",
"BOTH"
]
},
"groups": {
"_name_": "groups",
"title": "groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"portal": {
"type": "integer",
"_name_": "portal",
"title": "portal",
"_required_": true
},
"initiator": {
"type": [
"integer",
"null"
],
"_name_": "initiator",
"title": "initiator",
"default": null,
"_required_": false
},
"authmethod": {
"_name_": "authmethod",
"title": "authmethod",
"default": "NONE",
"_required_": false,
"type": "string",
"enum": [
"NONE",
"CHAP",
"CHAP_MUTUAL"
]
},
"auth": {
"type": [
"integer",
"null"
],
"_name_": "auth",
"title": "auth",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "group",
"title": "group",
"default": {},
"_required_": false,
"_attrs_order_": [
"portal",
"initiator",
"authmethod",
"auth"
]
}
],
"description": "`groups` is a list of group dictionaries which provide information related to using a `portal`, `initiator`,\n`authmethod` and `auth` with this target. `auth` represents a valid iSCSI Authorized Access and defaults to\nnull."
},
"auth_networks": {
"_name_": "auth_networks",
"title": "auth_networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "iscsi_target_create",
"title": "iscsi_target_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"alias",
"mode",
"groups",
"auth_networks"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_target_create_returns",
"title": "iscsi_target_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_TARGET_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Create an iSCSI Target.
|
iscsi.target.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete iSCSI Target of `id`."
}
{
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_TARGET_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Delete iSCSI Target of Deleting an iSCSI Target makes sure we delete all Associated Targets which use |
iscsi.target.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_target_entry",
"title": "iscsi_target_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_READ, SHARING_ISCSI_TARGET_READ, SHARING_ISCSI_TARGET_WRITE, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
iscsi.target.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_target_entry",
"title": "iscsi_target_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_target_entry",
"title": "iscsi_target_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_target_entry",
"title": "iscsi_target_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_READ, SHARING_ISCSI_TARGET_READ, SHARING_ISCSI_TARGET_WRITE, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.target.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update iSCSI Target of `id`.\nCreate an iSCSI Target."
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"alias": {
"_name_": "alias",
"title": "alias",
"_required_": false,
"type": [
"string",
"null"
]
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "ISCSI",
"_required_": false,
"type": "string",
"enum": [
"ISCSI",
"FC",
"BOTH"
]
},
"groups": {
"_name_": "groups",
"title": "groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"portal": {
"type": "integer",
"_name_": "portal",
"title": "portal",
"_required_": true
},
"initiator": {
"type": [
"integer",
"null"
],
"_name_": "initiator",
"title": "initiator",
"default": null,
"_required_": false
},
"authmethod": {
"_name_": "authmethod",
"title": "authmethod",
"default": "NONE",
"_required_": false,
"type": "string",
"enum": [
"NONE",
"CHAP",
"CHAP_MUTUAL"
]
},
"auth": {
"type": [
"integer",
"null"
],
"_name_": "auth",
"title": "auth",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "group",
"title": "group",
"default": {},
"_required_": false,
"_attrs_order_": [
"portal",
"initiator",
"authmethod",
"auth"
]
}
],
"description": "`groups` is a list of group dictionaries which provide information related to using a `portal`, `initiator`,\n`authmethod` and `auth` with this target. `auth` represents a valid iSCSI Authorized Access and defaults to\nnull."
},
"auth_networks": {
"_name_": "auth_networks",
"title": "auth_networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "iscsi_target_update",
"title": "iscsi_target_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"alias",
"mode",
"groups",
"auth_networks"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_target_update_returns",
"title": "iscsi_target_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_TARGET_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update iSCSI Target of |
iscsi.target.validate_name |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
{
"type": [
"integer",
"null"
],
"_name_": "existing_id",
"title": "existing_id",
"default": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_TARGET_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Returns validation error for iSCSI target name
:param name: name to be validated
:param existing_id: id of an existing iSCSI target that will receive this name (or |
iscsi.targetextent.create |
---|
Arguments:
{
"type": "object",
"properties": {
"target": {
"type": "integer",
"_name_": "target",
"title": "target",
"_required_": true
},
"lunid": {
"type": [
"integer",
"null"
],
"_name_": "lunid",
"title": "lunid",
"_required_": false
},
"extent": {
"type": "integer",
"_name_": "extent",
"title": "extent",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "iscsi_targetextent_create",
"title": "iscsi_targetextent_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"target",
"lunid",
"extent"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_targetextent_create_returns",
"title": "iscsi_targetextent_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_TARGETEXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Create an Associated Target.
|
iscsi.targetextent.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_TARGETEXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Delete Associated Target of |
iscsi.targetextent.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_targetextent_entry",
"title": "iscsi_targetextent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_READ, SHARING_ISCSI_TARGETEXTENT_READ, SHARING_ISCSI_TARGETEXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
iscsi.targetextent.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_targetextent_entry",
"title": "iscsi_targetextent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_targetextent_entry",
"title": "iscsi_targetextent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_targetextent_entry",
"title": "iscsi_targetextent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_ISCSI_READ, SHARING_ISCSI_TARGETEXTENT_READ, SHARING_ISCSI_TARGETEXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_READ, SHARING_WRITE |
- |
iscsi.targetextent.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Associated Target of `id`.\nCreate an Associated Target."
}
{
"type": "object",
"properties": {
"target": {
"type": "integer",
"_name_": "target",
"title": "target",
"_required_": true
},
"lunid": {
"type": "integer",
"_name_": "lunid",
"title": "lunid",
"_required_": false
},
"extent": {
"type": "integer",
"_name_": "extent",
"title": "extent",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "iscsi_targetextent_update",
"title": "iscsi_targetextent_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"target",
"lunid",
"extent"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_targetextent_update_returns",
"title": "iscsi_targetextent_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_ISCSI_TARGETEXTENT_WRITE, SHARING_ISCSI_WRITE, SHARING_WRITE |
Update Associated Target of |
jbof.create |
---|
Arguments:
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string",
"description": "`description` Optional description of the JBOF."
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string",
"description": "`mgmt_ip1` IP of 1st Redfish management interface."
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string",
"description": "`mgmt_ip2` Optional IP of 2nd Redfish management interface."
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string",
"description": "`mgmt_username` Redfish administrative username."
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_create",
"title": "jbof_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string",
"description": "`description` Optional description of the JBOF."
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string",
"description": "`mgmt_ip1` IP of 1st Redfish management interface."
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string",
"description": "`mgmt_ip2` Optional IP of 2nd Redfish management interface."
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string",
"description": "`mgmt_username` Redfish administrative username."
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_create_returns",
"title": "jbof_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
|
This method is accessible to the users granted with the following roles: JBOF_WRITE |
Create a new JBOF. This will use the supplied Redfish credentials to configure the data plane on the expansion shelf for direct connection to ROCE capable network cards on the TrueNAS head unit.
|
jbof.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: JBOF_WRITE |
Delete a JBOF by ID. |
jbof.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string"
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string"
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string"
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_entry",
"title": "jbof_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
|
This method is accessible to the users granted with the following roles: JBOF_READ, JBOF_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
jbof.licensed |
---|
Return Arguments:
{
"type": "integer",
"_name_": "licensed",
"title": "licensed",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: JBOF_READ, JBOF_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return a count of the number of JBOF units licensed. |
jbof.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string"
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string"
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string"
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_entry",
"title": "jbof_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string"
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string"
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string"
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_entry",
"title": "jbof_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string"
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string"
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string"
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_entry",
"title": "jbof_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: JBOF_READ, JBOF_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
jbof.reapply_config |
---|
Reapply the JBOF configuration to attached JBOFs. If an IOM is replaced in a JBOF, then it is expected to be configured to have the same redfish IP, user & password as was previously the case. This API can then be called to configure each JBOF with the expected data-plane IP configuration, and then attach NVMe drives. |
jbof.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update JBOF of `id`\nCreate a new JBOF."
}
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string",
"description": "`description` Optional description of the JBOF."
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string",
"description": "`mgmt_ip1` IP of 1st Redfish management interface."
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string",
"description": "`mgmt_ip2` Optional IP of 2nd Redfish management interface."
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string",
"description": "`mgmt_username` Redfish administrative username."
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_update",
"title": "jbof_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update JBOF of `id`\nCreate a new JBOF."
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string",
"description": "`description` Optional description of the JBOF."
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string",
"description": "`mgmt_ip1` IP of 1st Redfish management interface."
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string",
"description": "`mgmt_ip2` Optional IP of 2nd Redfish management interface."
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string",
"description": "`mgmt_username` Redfish administrative username."
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_update_returns",
"title": "jbof_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
|
This method is accessible to the users granted with the following roles: JBOF_WRITE |
Update JBOF of |
k8s_to_docker.list_backups
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "kubernetes_pool",
"title": "kubernetes_pool",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"error": {
"_name_": "error",
"title": "error",
"_required_": false,
"type": [
"string",
"null"
]
},
"backups": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "backups",
"title": "backups",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "backups",
"title": "backups",
"default": {},
"_required_": false,
"_attrs_order_": [
"error",
"backups"
]
}
|
This method is accessible to the users granted with the following roles: DOCKER_READ, DOCKER_WRITE, READONLY_ADMIN, SHARING_ADMIN |
List existing kubernetes backups |
k8s_to_docker.migrate
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "kubernetes_pool",
"title": "kubernetes_pool",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"backup_name": {
"_name_": "backup_name",
"title": "backup_name",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"backup_name"
]
}
|
Return Arguments:
{
"_name_": "app_migration_details",
"title": "app_migration_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"successfully_migrated": {
"type": "boolean",
"_name_": "successfully_migrated",
"title": "successfully_migrated",
"_required_": false
},
"error": {
"_name_": "error",
"title": "error",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "app_migration_detail",
"title": "app_migration_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"successfully_migrated",
"error"
]
}
]
}
|
This method is accessible to the users granted with the following roles: DOCKER_WRITE |
Migrate kubernetes backups to docker. |
kerberos.config |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "kerberos_entry",
"title": "kerberos_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
kerberos.update |
---|
Arguments:
{
"type": "object",
"properties": {
"appdefaults_aux": {
"_name_": "appdefaults_aux",
"title": "appdefaults_aux",
"_required_": false,
"type": "string",
"description": "`appdefaults_aux` add parameters to \"appdefaults\" section of the krb5.conf file."
},
"libdefaults_aux": {
"_name_": "libdefaults_aux",
"title": "libdefaults_aux",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "kerberos_settings_update",
"title": "kerberos_settings_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"appdefaults_aux",
"libdefaults_aux"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "kerberos_update_returns",
"title": "kerberos_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
|
kerberos.keytab.create |
---|
Arguments:
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string",
"description": "`file` b64encoded kerberos keytab"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_create",
"title": "kerberos_keytab_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string",
"description": "`file` b64encoded kerberos keytab"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_create_returns",
"title": "kerberos_keytab_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Create a kerberos keytab. Uploaded keytab files will be merged with the system keytab under /etc/krb5.keytab.
|
kerberos.keytab.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Delete kerberos keytab by id, and force regeneration of system keytab. |
kerberos.keytab.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_entry",
"title": "kerberos_keytab_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
kerberos.keytab.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_entry",
"title": "kerberos_keytab_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_entry",
"title": "kerberos_keytab_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_entry",
"title": "kerberos_keytab_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
kerberos.keytab.system_keytab_list |
---|
Return Arguments:
{
"_name_": "system-keytab",
"title": "system-keytab",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"slot": {
"type": "integer",
"_name_": "slot",
"title": "slot",
"_required_": false
},
"kvno": {
"type": "integer",
"_name_": "kvno",
"title": "kvno",
"_required_": false
},
"principal": {
"_name_": "principal",
"title": "principal",
"_required_": false,
"type": "string"
},
"etype": {
"_name_": "etype",
"title": "etype",
"_required_": false,
"type": "string"
},
"etype_deprecated": {
"type": "boolean",
"_name_": "etype_deprecated",
"title": "etype_deprecated",
"_required_": false
},
"date": {
"_name_": "date",
"title": "date",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "keytab-entry",
"title": "keytab-entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"slot",
"kvno",
"principal",
"etype",
"etype_deprecated",
"date"
]
}
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns content of system keytab (/etc/krb5.keytab). |
kerberos.keytab.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string",
"description": "`file` b64encoded kerberos keytab"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_update",
"title": "kerberos_keytab_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string",
"description": "`file` b64encoded kerberos keytab"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_update_returns",
"title": "kerberos_keytab_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Update kerberos keytab by id. |
kerberos.keytab.upload_keytab |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "keytab_data",
"title": "keytab_data",
"default": {},
"_required_": false,
"_attrs_order_": [
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_entry",
"title": "kerberos_keytab_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
}
|
Upload a keytab file. This method expects the keytab file to be uploaded using the /_upload/ endpoint. |
kerberos.realm.create |
---|
Arguments:
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_create",
"title": "kerberos_realm_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_create_returns",
"title": "kerberos_realm_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Create a new kerberos realm. This will be automatically populated during the domain join process in an Active Directory environment. Kerberos realm names are case-sensitive, but convention is to only use upper-case. Entries for kdc, admin_server, and kpasswd_server are not required. If they are unpopulated, then kerberos will use DNS srv records to discover the correct servers. The option to hard-code them is provided due to AD site discovery. Kerberos has no concept of Active Directory sites. This means that middleware performs the site discovery and sets the kerberos configuration based on the AD site. |
kerberos.realm.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Delete a kerberos realm by ID. |
kerberos.realm.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_entry",
"title": "kerberos_realm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
kerberos.realm.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_entry",
"title": "kerberos_realm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_entry",
"title": "kerberos_realm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_entry",
"title": "kerberos_realm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
kerberos.realm.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_update",
"title": "kerberos_realm_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_update_returns",
"title": "kerberos_realm_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server",
"id"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
Update a kerberos realm by id. This will be automatically populated during the domain join process in an Active Directory environment. Kerberos realm names are case-sensitive, but convention is to only use upper-case. |
keychaincredential.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Every Keychain Credential has a `name` which is used to distinguish it from others."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "The following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": [],
"description": "The following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required.\n * `SSH_CREDENTIALS`\n Which `attributes` are:\n * `host`\n * `port` (default 22)\n * `username` (default root)\n * `private_key` (Keychain Credential ID)\n * `remote_host_key` (you can use `keychaincredential.remote_ssh_host_key_scan` do discover it)\n * `connect_timeout` (default 10)"
}
},
"additionalProperties": false,
"_name_": "keychain_credential_create",
"title": "keychain_credential_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Every Keychain Credential has a `name` which is used to distinguish it from others."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "The following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": [],
"description": "The following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required.\n * `SSH_CREDENTIALS`\n Which `attributes` are:\n * `host`\n * `port` (default 22)\n * `username` (default root)\n * `private_key` (Keychain Credential ID)\n * `remote_host_key` (you can use `keychaincredential.remote_ssh_host_key_scan` do discover it)\n * `connect_timeout` (default 10)"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychaincredential_create_returns",
"title": "keychaincredential_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_WRITE, REPLICATION_ADMIN |
Create a Keychain Credential Create a Keychain Credential of any type.
Every Keychain Credential has a
|
|
keychaincredential.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete Keychain Credential with specific `id`"
}
{
"type": "object",
"properties": {
"cascade": {
"type": "boolean",
"_name_": "cascade",
"title": "cascade",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"cascade"
]
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_WRITE, REPLICATION_ADMIN |
Delete Keychain Credential with specific |
|
keychaincredential.generate_ssh_key_pair |
---|
Return Arguments:
{
"type": "object",
"properties": {
"private_key": {
"_name_": "private_key",
"title": "private_key",
"_required_": true,
"type": "string"
},
"public_key": {
"_name_": "public_key",
"title": "public_key",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ssh_key_pair",
"title": "ssh_key_pair",
"default": {},
"_required_": false,
"_attrs_order_": [
"private_key",
"public_key"
]
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_WRITE, REPLICATION_ADMIN |
Generate a public/private key pair Generate a public/private key pair (useful for |
|
keychaincredential.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "keychain_credential_entry",
"title": "keychain_credential_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_READ, KEYCHAIN_CREDENTIAL_WRITE, READONLY_ADMIN, REPLICATION_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
keychaincredential.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_credential_entry",
"title": "keychain_credential_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_credential_entry",
"title": "keychain_credential_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_credential_entry",
"title": "keychain_credential_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_READ, KEYCHAIN_CREDENTIAL_WRITE, READONLY_ADMIN, REPLICATION_ADMIN, SHARING_ADMIN |
- |
keychaincredential.remote_ssh_host_key_scan |
---|
Arguments:
{
"type": "object",
"properties": {
"host": {
"_name_": "host",
"title": "host",
"_required_": true,
"type": "string"
},
"port": {
"_name_": "port",
"title": "port",
"default": 22,
"_required_": false,
"type": "string"
},
"connect_timeout": {
"type": "integer",
"_name_": "connect_timeout",
"title": "connect_timeout",
"default": 10,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_remote_ssh_host_key_scan",
"title": "keychain_remote_ssh_host_key_scan",
"default": {},
"_required_": false,
"_attrs_order_": [
"host",
"port",
"connect_timeout"
]
}
|
Return Arguments:
{
"_name_": "remove_ssh_host_key",
"title": "remove_ssh_host_key",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_WRITE, REPLICATION_ADMIN |
Discover a remote host key Discover a remote host key (useful for |
|
keychaincredential.remote_ssh_semiautomatic_setup |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Perform semi-automatic SSH connection setup with other FreeNAS machine. It creates a `SSH_CREDENTIALS`\ncredential with specified `name` that can be used to connect to FreeNAS machine with specified `url` and\ntemporary auth `token`. Other FreeNAS machine adds `private_key` to allowed `username`'s private keys. Other"
},
"url": {
"_name_": "url",
"title": "url",
"_required_": true,
"type": "string",
"description": "Perform semi-automatic SSH connection setup with other FreeNAS machine. It creates a `SSH_CREDENTIALS`\ncredential with specified `name` that can be used to connect to FreeNAS machine with specified `url` and\ntemporary auth `token`. Other FreeNAS machine adds `private_key` to allowed `username`'s private keys. Other"
},
"verify_ssl": {
"type": "boolean",
"_name_": "verify_ssl",
"title": "verify_ssl",
"default": true,
"_required_": false
},
"token": {
"_name_": "token",
"title": "token",
"_required_": false,
"type": "string",
"description": "Perform semi-automatic SSH connection setup with other FreeNAS machine. It creates a `SSH_CREDENTIALS`\ncredential with specified `name` that can be used to connect to FreeNAS machine with specified `url` and\ntemporary auth `token`. Other FreeNAS machine adds `private_key` to allowed `username`'s private keys. Other"
},
"admin_username": {
"_name_": "admin_username",
"title": "admin_username",
"default": "root",
"_required_": false,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
},
"otp_token": {
"_name_": "otp_token",
"title": "otp_token",
"_required_": false,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"default": "root",
"_required_": false,
"type": "string",
"description": "Perform semi-automatic SSH connection setup with other FreeNAS machine. It creates a `SSH_CREDENTIALS`\ncredential with specified `name` that can be used to connect to FreeNAS machine with specified `url` and\ntemporary auth `token`. Other FreeNAS machine adds `private_key` to allowed `username`'s private keys. Other"
},
"private_key": {
"type": "integer",
"_name_": "private_key",
"title": "private_key",
"_required_": true,
"description": "Perform semi-automatic SSH connection setup with other FreeNAS machine. It creates a `SSH_CREDENTIALS`\ncredential with specified `name` that can be used to connect to FreeNAS machine with specified `url` and\ntemporary auth `token`. Other FreeNAS machine adds `private_key` to allowed `username`'s private keys. Other"
},
"connect_timeout": {
"type": "integer",
"_name_": "connect_timeout",
"title": "connect_timeout",
"default": 10,
"_required_": false,
"description": "`SSH_CREDENTIALS` attributes such as `connect_timeout` can be specified as well."
},
"sudo": {
"type": "boolean",
"_name_": "sudo",
"title": "sudo",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_remote_ssh_semiautomatic_setup",
"title": "keychain_remote_ssh_semiautomatic_setup",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"url",
"verify_ssl",
"token",
"admin_username",
"password",
"otp_token",
"username",
"private_key",
"connect_timeout",
"sudo"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Perform semi-automatic SSH connection setup with other FreeNAS machine. It creates a `SSH_CREDENTIALS`\ncredential with specified `name` that can be used to connect to FreeNAS machine with specified `url` and\ntemporary auth `token`. Other FreeNAS machine adds `private_key` to allowed `username`'s private keys. Other\n`SSH_CREDENTIALS` attributes such as `connect_timeout` can be specified as well."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_credential_entry",
"title": "keychain_credential_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_WRITE, REPLICATION_ADMIN |
Perform semi-automatic SSH connection setup with other FreeNAS machine Perform semi-automatic SSH connection setup with other FreeNAS machine. It creates a |
|
keychaincredential.setup_ssh_connection |
---|
Arguments:
{
"type": "object",
"properties": {
"private_key": {
"type": "object",
"properties": {
"generate_key": {
"type": "boolean",
"_name_": "generate_key",
"title": "generate_key",
"default": true,
"_required_": false
},
"existing_key_id": {
"type": "integer",
"_name_": "existing_key_id",
"title": "existing_key_id",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "private_key",
"title": "private_key",
"default": {},
"_required_": false,
"_attrs_order_": [
"generate_key",
"existing_key_id",
"name"
]
},
"connection_name": {
"_name_": "connection_name",
"title": "connection_name",
"_required_": true,
"type": "string"
},
"setup_type": {
"_name_": "setup_type",
"title": "setup_type",
"default": "MANUAL",
"_required_": true,
"type": "string",
"enum": [
"SEMI-AUTOMATIC",
"MANUAL"
],
"description": "1) Generating SSH Key Pair if required\n2) Setting up SSH Credentials based on `setup_type`"
},
"semi_automatic_setup": {
"type": "object",
"properties": {
"url": {
"_name_": "url",
"title": "url",
"_required_": true,
"type": "string"
},
"verify_ssl": {
"type": "boolean",
"_name_": "verify_ssl",
"title": "verify_ssl",
"default": true,
"_required_": false
},
"token": {
"_name_": "token",
"title": "token",
"_required_": false,
"type": "string"
},
"admin_username": {
"_name_": "admin_username",
"title": "admin_username",
"default": "root",
"_required_": false,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
},
"otp_token": {
"_name_": "otp_token",
"title": "otp_token",
"_required_": false,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"default": "root",
"_required_": false,
"type": "string"
},
"connect_timeout": {
"type": "integer",
"_name_": "connect_timeout",
"title": "connect_timeout",
"default": 10,
"_required_": false
},
"sudo": {
"type": "boolean",
"_name_": "sudo",
"title": "sudo",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "semi_automatic_setup",
"title": "semi_automatic_setup",
"default": null,
"_required_": false,
"_attrs_order_": [
"url",
"verify_ssl",
"token",
"admin_username",
"password",
"otp_token",
"username",
"connect_timeout",
"sudo"
]
},
"manual_setup": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "manual_setup",
"title": "manual_setup",
"default": null,
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "setup_ssh_connection",
"title": "setup_ssh_connection",
"default": {},
"_required_": false,
"_attrs_order_": [
"private_key",
"connection_name",
"setup_type",
"semi_automatic_setup",
"manual_setup"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_credential_entry",
"title": "keychain_credential_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_WRITE, REPLICATION_ADMIN |
Creates a SSH Connection performing the following steps: 1) Generating SSH Key Pair if required
2) Setting up SSH Credentials based on In case (2) fails, it will be ensured that SSH Key Pair generated ( if applicable ) in the process is removed. |
keychaincredential.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update a Keychain Credential with specific `id`"
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Every Keychain Credential has a `name` which is used to distinguish it from others.\nThe following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": [],
"description": "Also you must specify full `attributes` value\nEvery Keychain Credential has a `name` which is used to distinguish it from others.\nThe following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required.\n * `SSH_CREDENTIALS`\n Which `attributes` are:\n * `host`\n * `port` (default 22)\n * `username` (default root)\n * `private_key` (Keychain Credential ID)\n * `remote_host_key` (you can use `keychaincredential.remote_ssh_host_key_scan` do discover it)\n * `connect_timeout` (default 10)"
}
},
"additionalProperties": false,
"_name_": "keychain_credential_update",
"title": "keychain_credential_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"attributes"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "Every Keychain Credential has a `name` which is used to distinguish it from others."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"description": "Please note that you can't change `type`\nThe following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": [],
"description": "Also you must specify full `attributes` value\nThe following `type`s are supported:\n * `SSH_KEY_PAIR`\n Which `attributes` are:\n * `private_key`\n * `public_key` (which can be omitted and thus automatically derived from private key)\n At least one attribute is required.\n * `SSH_CREDENTIALS`\n Which `attributes` are:\n * `host`\n * `port` (default 22)\n * `username` (default root)\n * `private_key` (Keychain Credential ID)\n * `remote_host_key` (you can use `keychaincredential.remote_ssh_host_key_scan` do discover it)\n * `connect_timeout` (default 10)"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update a Keychain Credential with specific `id`"
}
},
"additionalProperties": false,
"_name_": "keychaincredential_update_returns",
"title": "keychaincredential_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
|
This method is accessible to the users granted with the following roles: KEYCHAIN_CREDENTIAL_WRITE, REPLICATION_ADMIN |
Update a Keychain Credential with specific Please note that you can't change Also you must specify full See the documentation for |
|
keychaincredential.used_by |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"_name_": "credential_results",
"title": "credential_results",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"unbind_method": {
"_name_": "unbind_method",
"title": "unbind_method",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "credential_result",
"title": "credential_result",
"default": {},
"_required_": false,
"_attrs_order_": [
"title",
"unbind_method"
]
}
]
}
|
Returns list of objects that use this credential. |
kmip.clear_sync_pending_keys |
---|
This method is accessible to the users granted with the following roles: KMIP_WRITE |
Clear all keys which are pending to be synced between KMIP server and TN database. For ZFS/SED keys, we remove the UID from local database with which we are able to retrieve ZFS/SED keys. It should be used with caution. |
kmip.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"manage_sed_disks": {
"type": "boolean",
"_name_": "manage_sed_disks",
"title": "manage_sed_disks",
"_required_": true
},
"manage_zfs_keys": {
"type": "boolean",
"_name_": "manage_zfs_keys",
"title": "manage_zfs_keys",
"_required_": true
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": true
},
"certificate_authority": {
"type": [
"integer",
"null"
],
"_name_": "certificate_authority",
"title": "certificate_authority",
"_required_": true
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"server": {
"_name_": "server",
"title": "server",
"_required_": true,
"type": [
"string",
"null"
]
},
"ssl_version": {
"_name_": "ssl_version",
"title": "ssl_version",
"_required_": true,
"type": "string",
"enum": [
"PROTOCOL_TLSv1",
"PROTOCOL_TLSv1_1",
"PROTOCOL_TLSv1_2"
]
}
},
"additionalProperties": false,
"_name_": "kmip_entry",
"title": "kmip_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"manage_sed_disks",
"manage_zfs_keys",
"certificate",
"certificate_authority",
"port",
"server",
"ssl_version"
]
}
|
This method is accessible to the users granted with the following roles: KMIP_READ, KMIP_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
kmip.kmip_sync_pending |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "pending_kmip_sync",
"title": "pending_kmip_sync",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: KMIP_READ, KMIP_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns true or false based on if there are keys which are to be synced from local database to remote KMIP server or vice versa. |
kmip.ssl_version_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"PROTOCOL_TLSv1": {
"_name_": "PROTOCOL_TLSv1",
"title": "PROTOCOL_TLSv1",
"_required_": false,
"type": "string",
"enum": [
"PROTOCOL_TLSv1"
]
},
"PROTOCOL_TLSv1_1": {
"_name_": "PROTOCOL_TLSv1_1",
"title": "PROTOCOL_TLSv1_1",
"_required_": false,
"type": "string",
"enum": [
"PROTOCOL_TLSv1_1"
]
},
"PROTOCOL_TLSv1_2": {
"_name_": "PROTOCOL_TLSv1_2",
"title": "PROTOCOL_TLSv1_2",
"_required_": false,
"type": "string",
"enum": [
"PROTOCOL_TLSv1_2"
]
}
},
"additionalProperties": false,
"_name_": "ssl_version_choices",
"title": "ssl_version_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"PROTOCOL_TLSv1",
"PROTOCOL_TLSv1_1",
"PROTOCOL_TLSv1_2"
]
}
|
This method is accessible to the users granted with the following roles: KMIP_READ, KMIP_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve valid SSL version choices to be used when configuring kmip service. |
kmip.sync_keys |
---|
This method is accessible to the users granted with the following roles: KMIP_WRITE |
Sync ZFS/SED keys between KMIP Server and TN database. |
kmip.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false,
"description": "`enabled` if true, cannot be set to disabled if there are existing keys pending to be synced. However users\ncan still perform this action by enabling `force_clear`."
},
"manage_sed_disks": {
"type": "boolean",
"_name_": "manage_sed_disks",
"title": "manage_sed_disks",
"_required_": true,
"description": "`manage_zfs_keys`/`manage_sed_disks` when enabled will sync keys from local database to remote KMIP server.\nWhen disabled, if there are any keys left to be retrieved from the KMIP server,\nit will sync them back to local database."
},
"manage_zfs_keys": {
"type": "boolean",
"_name_": "manage_zfs_keys",
"title": "manage_zfs_keys",
"_required_": true,
"description": "`manage_zfs_keys`/`manage_sed_disks` when enabled will sync keys from local database to remote KMIP server.\nWhen disabled, if there are any keys left to be retrieved from the KMIP server,\nit will sync them back to local database."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": true,
"description": "System currently authenticates connection with remote KMIP Server with a TLS handshake. `certificate` and"
},
"certificate_authority": {
"type": [
"integer",
"null"
],
"_name_": "certificate_authority",
"title": "certificate_authority",
"_required_": true,
"description": "`certificate_authority` determine the certs which will be used to initiate the TLS handshake with `server`."
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"server": {
"_name_": "server",
"title": "server",
"_required_": true,
"type": [
"string",
"null"
],
"description": "`certificate_authority` determine the certs which will be used to initiate the TLS handshake with `server`.\n`validate` is enabled by default. When enabled, system will test connection to `server` making sure\nit's reachable."
},
"ssl_version": {
"_name_": "ssl_version",
"title": "ssl_version",
"_required_": true,
"type": "string",
"enum": [
"PROTOCOL_TLSv1",
"PROTOCOL_TLSv1_1",
"PROTOCOL_TLSv1_2"
],
"description": "`ssl_version` can be specified to match the ssl configuration being used by KMIP server."
},
"force_clear": {
"type": "boolean",
"_name_": "force_clear",
"title": "force_clear",
"_required_": false,
"description": "`enabled` if true, cannot be set to disabled if there are existing keys pending to be synced. However users\ncan still perform this action by enabling `force_clear`.\n`change_server` is a boolean field which allows users to migrate data between two KMIP servers. System\nwill first migrate keys from old KMIP server to local database and then migrate the keys from local database\nto new KMIP server. If it is unable to retrieve all the keys from old server, this will fail. Users can bypass\nthis by enabling `force_clear`."
},
"change_server": {
"type": "boolean",
"_name_": "change_server",
"title": "change_server",
"_required_": false,
"description": "`change_server` is a boolean field which allows users to migrate data between two KMIP servers. System\nwill first migrate keys from old KMIP server to local database and then migrate the keys from local database\nto new KMIP server. If it is unable to retrieve all the keys from old server, this will fail. Users can bypass\nthis by enabling `force_clear`."
},
"validate": {
"type": "boolean",
"_name_": "validate",
"title": "validate",
"_required_": false,
"description": "`validate` is enabled by default. When enabled, system will test connection to `server` making sure\nit's reachable."
}
},
"additionalProperties": false,
"_name_": "kmip_update",
"title": "kmip_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"manage_sed_disks",
"manage_zfs_keys",
"certificate",
"certificate_authority",
"port",
"server",
"ssl_version",
"force_clear",
"change_server",
"validate"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true,
"description": "`enabled` if true, cannot be set to disabled if there are existing keys pending to be synced. However users\ncan still perform this action by enabling `force_clear`."
},
"manage_sed_disks": {
"type": "boolean",
"_name_": "manage_sed_disks",
"title": "manage_sed_disks",
"_required_": true,
"description": "`manage_zfs_keys`/`manage_sed_disks` when enabled will sync keys from local database to remote KMIP server.\nWhen disabled, if there are any keys left to be retrieved from the KMIP server,\nit will sync them back to local database."
},
"manage_zfs_keys": {
"type": "boolean",
"_name_": "manage_zfs_keys",
"title": "manage_zfs_keys",
"_required_": true,
"description": "`manage_zfs_keys`/`manage_sed_disks` when enabled will sync keys from local database to remote KMIP server.\nWhen disabled, if there are any keys left to be retrieved from the KMIP server,\nit will sync them back to local database."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": true,
"description": "System currently authenticates connection with remote KMIP Server with a TLS handshake. `certificate` and"
},
"certificate_authority": {
"type": [
"integer",
"null"
],
"_name_": "certificate_authority",
"title": "certificate_authority",
"_required_": true,
"description": "`certificate_authority` determine the certs which will be used to initiate the TLS handshake with `server`."
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"server": {
"_name_": "server",
"title": "server",
"_required_": true,
"type": [
"string",
"null"
],
"description": "`certificate_authority` determine the certs which will be used to initiate the TLS handshake with `server`.\n`validate` is enabled by default. When enabled, system will test connection to `server` making sure\nit's reachable."
},
"ssl_version": {
"_name_": "ssl_version",
"title": "ssl_version",
"_required_": true,
"type": "string",
"enum": [
"PROTOCOL_TLSv1",
"PROTOCOL_TLSv1_1",
"PROTOCOL_TLSv1_2"
],
"description": "`ssl_version` can be specified to match the ssl configuration being used by KMIP server."
}
},
"additionalProperties": false,
"_name_": "kmip_update_returns",
"title": "kmip_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"manage_sed_disks",
"manage_zfs_keys",
"certificate",
"certificate_authority",
"port",
"server",
"ssl_version"
]
}
|
This method is accessible to the users granted with the following roles: KMIP_WRITE |
Update KMIP Server Configuration. System currently authenticates connection with remote KMIP Server with a TLS handshake.
|
ldap.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"hostname": {
"_name_": "hostname",
"title": "hostname",
"default": null,
"_required_": false,
"type": "array",
"items": []
},
"basedn": {
"_name_": "basedn",
"title": "basedn",
"_required_": false,
"type": "string"
},
"binddn": {
"_name_": "binddn",
"title": "binddn",
"_required_": false,
"type": "string"
},
"bindpw": {
"_name_": "bindpw",
"title": "bindpw",
"_required_": false,
"type": "string"
},
"anonbind": {
"type": "boolean",
"_name_": "anonbind",
"title": "anonbind",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
},
"disable_freenas_cache": {
"type": "boolean",
"_name_": "disable_freenas_cache",
"title": "disable_freenas_cache",
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 30,
"_required_": false
},
"dns_timeout": {
"type": "integer",
"_name_": "dns_timeout",
"title": "dns_timeout",
"default": 5,
"_required_": false
},
"kerberos_realm": {
"type": [
"integer",
"null"
],
"_name_": "kerberos_realm",
"title": "kerberos_realm",
"_required_": false
},
"kerberos_principal": {
"_name_": "kerberos_principal",
"title": "kerberos_principal",
"_required_": false,
"type": "string"
},
"auxiliary_parameters": {
"_name_": "auxiliary_parameters",
"title": "auxiliary_parameters",
"_required_": false,
"type": "string"
},
"schema": {
"_name_": "schema",
"title": "nss_info_ldap",
"default": "RFC2307",
"_required_": false,
"type": "string",
"enum": [
"RFC2307",
"RFC2307BIS"
]
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"search_bases": {
"type": "object",
"properties": {
"base_user": {
"_name_": "base_user",
"title": "base_user",
"_required_": false,
"type": [
"string",
"null"
]
},
"base_group": {
"_name_": "base_group",
"title": "base_group",
"_required_": false,
"type": [
"string",
"null"
]
},
"base_netgroup": {
"_name_": "base_netgroup",
"title": "base_netgroup",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "search_bases",
"title": "search_bases",
"default": {},
"_required_": false,
"_attrs_order_": [
"base_user",
"base_group",
"base_netgroup"
]
},
"attribute_maps": {
"type": "object",
"properties": {
"passwd": {
"type": "object",
"properties": {
"user_object_class": {
"_name_": "user_object_class",
"title": "user_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_name": {
"_name_": "user_name",
"title": "user_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_uid": {
"_name_": "user_uid",
"title": "user_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_gid": {
"_name_": "user_gid",
"title": "user_gid",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_gecos": {
"_name_": "user_gecos",
"title": "user_gecos",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_home_directory": {
"_name_": "user_home_directory",
"title": "user_home_directory",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_shell": {
"_name_": "user_shell",
"title": "user_shell",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "passwd",
"title": "passwd",
"default": {},
"_required_": false,
"_attrs_order_": [
"user_object_class",
"user_name",
"user_uid",
"user_gid",
"user_gecos",
"user_home_directory",
"user_shell"
]
},
"shadow": {
"type": "object",
"properties": {
"shadow_object_class": {
"_name_": "shadow_object_class",
"title": "shadow_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_last_change": {
"_name_": "shadow_last_change",
"title": "shadow_last_change",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_min": {
"_name_": "shadow_min",
"title": "shadow_min",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_max": {
"_name_": "shadow_max",
"title": "shadow_max",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_warning": {
"_name_": "shadow_warning",
"title": "shadow_warning",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_inactive": {
"_name_": "shadow_inactive",
"title": "shadow_inactive",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_expire": {
"_name_": "shadow_expire",
"title": "shadow_expire",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "shadow",
"title": "shadow",
"default": {},
"_required_": false,
"_attrs_order_": [
"shadow_object_class",
"shadow_last_change",
"shadow_min",
"shadow_max",
"shadow_warning",
"shadow_inactive",
"shadow_expire"
]
},
"group": {
"type": "object",
"properties": {
"group_object_class": {
"_name_": "group_object_class",
"title": "group_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"group_gid": {
"_name_": "group_gid",
"title": "group_gid",
"_required_": false,
"type": [
"string",
"null"
]
},
"group_member": {
"_name_": "group_member",
"title": "group_member",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "group",
"title": "group",
"default": {},
"_required_": false,
"_attrs_order_": [
"group_object_class",
"group_gid",
"group_member"
]
},
"netgroup": {
"type": "object",
"properties": {
"netgroup_object_class": {
"_name_": "netgroup_object_class",
"title": "netgroup_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"netgroup_member": {
"_name_": "netgroup_member",
"title": "netgroup_member",
"_required_": false,
"type": [
"string",
"null"
]
},
"netgroup_triple": {
"_name_": "netgroup_triple",
"title": "netgroup_triple",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "netgroup",
"title": "netgroup",
"default": {},
"_required_": false,
"_attrs_order_": [
"netgroup_object_class",
"netgroup_member",
"netgroup_triple"
]
}
},
"additionalProperties": false,
"_name_": "attribute_maps",
"title": "attribute_maps",
"default": {},
"_required_": false,
"_attrs_order_": [
"passwd",
"shadow",
"group",
"netgroup"
]
}
},
"additionalProperties": false,
"_name_": "ldap_update",
"title": "ldap_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"hostname",
"basedn",
"binddn",
"bindpw",
"anonbind",
"ssl",
"certificate",
"validate_certificates",
"disable_freenas_cache",
"timeout",
"dns_timeout",
"kerberos_realm",
"kerberos_principal",
"auxiliary_parameters",
"schema",
"enable",
"search_bases",
"attribute_maps"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
ldap.schema_choices |
---|
Return Arguments:
{
"_name_": "schema_choices",
"title": "schema_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "nss_info_ldap",
"title": "nss_info_ldap",
"default": "RFC2307",
"_required_": false,
"type": "string",
"enum": [
"RFC2307",
"RFC2307BIS"
]
}
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns list of available LDAP schema choices. |
ldap.ssl_choices |
---|
Return Arguments:
{
"_name_": "ssl_choices",
"title": "ssl_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
}
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_READ, DIRECTORY_SERVICE_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns list of SSL choices. |
ldap.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"hostname": {
"_name_": "hostname",
"title": "hostname",
"default": null,
"_required_": false,
"type": "array",
"items": [],
"description": "`hostname` list of ip addresses or hostnames of LDAP servers with\nwhich to communicate in order of preference. Failover only occurs\nif the current LDAP server is unresponsive."
},
"basedn": {
"_name_": "basedn",
"title": "basedn",
"_required_": false,
"type": "string",
"description": "`basedn` specifies the default base DN to use when performing ldap\noperations. The base must be specified as a Distinguished Name in LDAP\nformat."
},
"binddn": {
"_name_": "binddn",
"title": "binddn",
"_required_": false,
"type": "string",
"description": "`binddn` specifies the default bind DN to use when performing ldap\noperations. The bind DN must be specified as a Distinguished Name in\nLDAP format.\n`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"bindpw": {
"_name_": "bindpw",
"title": "bindpw",
"_required_": false,
"type": "string",
"description": "`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"anonbind": {
"type": "boolean",
"_name_": "anonbind",
"title": "anonbind",
"default": false,
"_required_": false,
"description": "`anonbind` use anonymous authentication."
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
],
"description": "`ssl` establish SSL/TLS-protected connections to the LDAP server(s).\nGSSAPI signing is disabled on SSL/TLS-protected connections if\nkerberos authentication is used."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"description": "`certificate` LDAPs client certificate to be used for certificate-\nbased authentication."
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false,
"description": "`validate_certificates` specifies whether to perform checks on server\ncertificates in a TLS session. If enabled, TLS_REQCERT demand is set.\nThe server certificate is requested. If no certificate is provided or\nif a bad certificate is provided, the session is immediately terminated.\nIf disabled, TLS_REQCERT allow is set. The server certificate is\nrequested, but all errors are ignored."
},
"disable_freenas_cache": {
"type": "boolean",
"_name_": "disable_freenas_cache",
"title": "disable_freenas_cache",
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 30,
"_required_": false,
"description": "`timeout` specifies a timeout (in seconds) after which calls to\nsynchronous LDAP APIs will abort if no response is received."
},
"dns_timeout": {
"type": "integer",
"_name_": "dns_timeout",
"title": "dns_timeout",
"default": 5,
"_required_": false,
"description": "`dns_timeout` specifies the timeout (in seconds) after which the\npoll(2)/select(2) following a connect(2) returns in case of no activity\nfor openldap. For nslcd this specifies the time limit (in seconds) to\nuse when connecting to the directory server. This directly impacts the\nlength of time that the LDAP service tries before failing over to\na secondary LDAP URI."
},
"kerberos_realm": {
"type": [
"integer",
"null"
],
"_name_": "kerberos_realm",
"title": "kerberos_realm",
"_required_": false,
"description": "`kerberos_realm` in which the server is located. This parameter is\nonly required for SASL GSSAPI authentication to the remote LDAP server.\n`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"kerberos_principal": {
"_name_": "kerberos_principal",
"title": "kerberos_principal",
"_required_": false,
"type": "string",
"description": "`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"auxiliary_parameters": {
"_name_": "auxiliary_parameters",
"title": "auxiliary_parameters",
"_required_": false,
"type": "string"
},
"schema": {
"_name_": "schema",
"title": "nss_info_ldap",
"default": "RFC2307",
"_required_": false,
"type": "string",
"enum": [
"RFC2307",
"RFC2307BIS"
]
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"search_bases": {
"type": "object",
"properties": {
"base_user": {
"_name_": "base_user",
"title": "base_user",
"_required_": false,
"type": [
"string",
"null"
]
},
"base_group": {
"_name_": "base_group",
"title": "base_group",
"_required_": false,
"type": [
"string",
"null"
]
},
"base_netgroup": {
"_name_": "base_netgroup",
"title": "base_netgroup",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "search_bases",
"title": "search_bases",
"default": {},
"_required_": false,
"_attrs_order_": [
"base_user",
"base_group",
"base_netgroup"
],
"description": "`search_bases` - these parameters allow specifying a non-standard\nsearch base for users (`base_user`), groups (`base_group`), and\nnetgroups (`base_netgroup`). Must be a valid LDAP DN. No remote\nvalidation is performed that the search base exists or contains\nexpected objects."
},
"attribute_maps": {
"type": "object",
"properties": {
"passwd": {
"type": "object",
"properties": {
"user_object_class": {
"_name_": "user_object_class",
"title": "user_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_name": {
"_name_": "user_name",
"title": "user_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_uid": {
"_name_": "user_uid",
"title": "user_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_gid": {
"_name_": "user_gid",
"title": "user_gid",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_gecos": {
"_name_": "user_gecos",
"title": "user_gecos",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_home_directory": {
"_name_": "user_home_directory",
"title": "user_home_directory",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_shell": {
"_name_": "user_shell",
"title": "user_shell",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "passwd",
"title": "passwd",
"default": {},
"_required_": false,
"_attrs_order_": [
"user_object_class",
"user_name",
"user_uid",
"user_gid",
"user_gecos",
"user_home_directory",
"user_shell"
]
},
"shadow": {
"type": "object",
"properties": {
"shadow_object_class": {
"_name_": "shadow_object_class",
"title": "shadow_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_last_change": {
"_name_": "shadow_last_change",
"title": "shadow_last_change",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_min": {
"_name_": "shadow_min",
"title": "shadow_min",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_max": {
"_name_": "shadow_max",
"title": "shadow_max",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_warning": {
"_name_": "shadow_warning",
"title": "shadow_warning",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_inactive": {
"_name_": "shadow_inactive",
"title": "shadow_inactive",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_expire": {
"_name_": "shadow_expire",
"title": "shadow_expire",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "shadow",
"title": "shadow",
"default": {},
"_required_": false,
"_attrs_order_": [
"shadow_object_class",
"shadow_last_change",
"shadow_min",
"shadow_max",
"shadow_warning",
"shadow_inactive",
"shadow_expire"
]
},
"group": {
"type": "object",
"properties": {
"group_object_class": {
"_name_": "group_object_class",
"title": "group_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"group_gid": {
"_name_": "group_gid",
"title": "group_gid",
"_required_": false,
"type": [
"string",
"null"
]
},
"group_member": {
"_name_": "group_member",
"title": "group_member",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "group",
"title": "group",
"default": {},
"_required_": false,
"_attrs_order_": [
"group_object_class",
"group_gid",
"group_member"
]
},
"netgroup": {
"type": "object",
"properties": {
"netgroup_object_class": {
"_name_": "netgroup_object_class",
"title": "netgroup_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"netgroup_member": {
"_name_": "netgroup_member",
"title": "netgroup_member",
"_required_": false,
"type": [
"string",
"null"
]
},
"netgroup_triple": {
"_name_": "netgroup_triple",
"title": "netgroup_triple",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "netgroup",
"title": "netgroup",
"default": {},
"_required_": false,
"_attrs_order_": [
"netgroup_object_class",
"netgroup_member",
"netgroup_triple"
]
}
},
"additionalProperties": false,
"_name_": "attribute_maps",
"title": "attribute_maps",
"default": {},
"_required_": false,
"_attrs_order_": [
"passwd",
"shadow",
"group",
"netgroup"
],
"description": "`attribute_maps` - allow specifying alternate non-RFC-compliant\nattribute names for `passwd`, `shadow`, `group`, and `netgroup` object\nclasses as specified in RFC 2307. Setting key to `null` has special\nmeaning that RFC defaults for the configure `nss_info_schema` will\nbe used."
}
},
"additionalProperties": false,
"_name_": "ldap_update",
"title": "ldap_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"hostname",
"basedn",
"binddn",
"bindpw",
"anonbind",
"ssl",
"certificate",
"validate_certificates",
"disable_freenas_cache",
"timeout",
"dns_timeout",
"kerberos_realm",
"kerberos_principal",
"auxiliary_parameters",
"schema",
"enable",
"search_bases",
"attribute_maps"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"hostname": {
"_name_": "hostname",
"title": "hostname",
"default": null,
"_required_": false,
"type": "array",
"items": [],
"description": "`hostname` list of ip addresses or hostnames of LDAP servers with\nwhich to communicate in order of preference. Failover only occurs\nif the current LDAP server is unresponsive."
},
"basedn": {
"_name_": "basedn",
"title": "basedn",
"_required_": false,
"type": "string",
"description": "`basedn` specifies the default base DN to use when performing ldap\noperations. The base must be specified as a Distinguished Name in LDAP\nformat."
},
"binddn": {
"_name_": "binddn",
"title": "binddn",
"_required_": false,
"type": "string",
"description": "`binddn` specifies the default bind DN to use when performing ldap\noperations. The bind DN must be specified as a Distinguished Name in\nLDAP format.\n`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"bindpw": {
"_name_": "bindpw",
"title": "bindpw",
"_required_": false,
"type": "string",
"description": "`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"anonbind": {
"type": "boolean",
"_name_": "anonbind",
"title": "anonbind",
"default": false,
"_required_": false,
"description": "`anonbind` use anonymous authentication."
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
],
"description": "`ssl` establish SSL/TLS-protected connections to the LDAP server(s).\nGSSAPI signing is disabled on SSL/TLS-protected connections if\nkerberos authentication is used."
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"description": "`certificate` LDAPs client certificate to be used for certificate-\nbased authentication."
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false,
"description": "`validate_certificates` specifies whether to perform checks on server\ncertificates in a TLS session. If enabled, TLS_REQCERT demand is set.\nThe server certificate is requested. If no certificate is provided or\nif a bad certificate is provided, the session is immediately terminated.\nIf disabled, TLS_REQCERT allow is set. The server certificate is\nrequested, but all errors are ignored."
},
"disable_freenas_cache": {
"type": "boolean",
"_name_": "disable_freenas_cache",
"title": "disable_freenas_cache",
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 30,
"_required_": false,
"description": "`timeout` specifies a timeout (in seconds) after which calls to\nsynchronous LDAP APIs will abort if no response is received."
},
"dns_timeout": {
"type": "integer",
"_name_": "dns_timeout",
"title": "dns_timeout",
"default": 5,
"_required_": false,
"description": "`dns_timeout` specifies the timeout (in seconds) after which the\npoll(2)/select(2) following a connect(2) returns in case of no activity\nfor openldap. For nslcd this specifies the time limit (in seconds) to\nuse when connecting to the directory server. This directly impacts the\nlength of time that the LDAP service tries before failing over to\na secondary LDAP URI."
},
"kerberos_realm": {
"type": [
"integer",
"null"
],
"_name_": "kerberos_realm",
"title": "kerberos_realm",
"_required_": false,
"description": "`kerberos_realm` in which the server is located. This parameter is\nonly required for SASL GSSAPI authentication to the remote LDAP server.\n`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"kerberos_principal": {
"_name_": "kerberos_principal",
"title": "kerberos_principal",
"_required_": false,
"type": "string",
"description": "`kerberos_principal` kerberos principal to use for SASL GSSAPI\nauthentication to the remote server. If `kerberos_realm` is specified\nwithout a keytab, then the `binddn` and `bindpw` are used to\nperform to obtain the ticket necessary for GSSAPI authentication."
},
"auxiliary_parameters": {
"_name_": "auxiliary_parameters",
"title": "auxiliary_parameters",
"_required_": false,
"type": "string"
},
"schema": {
"_name_": "schema",
"title": "nss_info_ldap",
"default": "RFC2307",
"_required_": false,
"type": "string",
"enum": [
"RFC2307",
"RFC2307BIS"
]
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"search_bases": {
"type": "object",
"properties": {
"base_user": {
"_name_": "base_user",
"title": "base_user",
"_required_": false,
"type": [
"string",
"null"
]
},
"base_group": {
"_name_": "base_group",
"title": "base_group",
"_required_": false,
"type": [
"string",
"null"
]
},
"base_netgroup": {
"_name_": "base_netgroup",
"title": "base_netgroup",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "search_bases",
"title": "search_bases",
"default": {},
"_required_": false,
"_attrs_order_": [
"base_user",
"base_group",
"base_netgroup"
],
"description": "`search_bases` - these parameters allow specifying a non-standard\nsearch base for users (`base_user`), groups (`base_group`), and\nnetgroups (`base_netgroup`). Must be a valid LDAP DN. No remote\nvalidation is performed that the search base exists or contains\nexpected objects."
},
"attribute_maps": {
"type": "object",
"properties": {
"passwd": {
"type": "object",
"properties": {
"user_object_class": {
"_name_": "user_object_class",
"title": "user_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_name": {
"_name_": "user_name",
"title": "user_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_uid": {
"_name_": "user_uid",
"title": "user_uid",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_gid": {
"_name_": "user_gid",
"title": "user_gid",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_gecos": {
"_name_": "user_gecos",
"title": "user_gecos",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_home_directory": {
"_name_": "user_home_directory",
"title": "user_home_directory",
"_required_": false,
"type": [
"string",
"null"
]
},
"user_shell": {
"_name_": "user_shell",
"title": "user_shell",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "passwd",
"title": "passwd",
"default": {},
"_required_": false,
"_attrs_order_": [
"user_object_class",
"user_name",
"user_uid",
"user_gid",
"user_gecos",
"user_home_directory",
"user_shell"
]
},
"shadow": {
"type": "object",
"properties": {
"shadow_object_class": {
"_name_": "shadow_object_class",
"title": "shadow_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_last_change": {
"_name_": "shadow_last_change",
"title": "shadow_last_change",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_min": {
"_name_": "shadow_min",
"title": "shadow_min",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_max": {
"_name_": "shadow_max",
"title": "shadow_max",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_warning": {
"_name_": "shadow_warning",
"title": "shadow_warning",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_inactive": {
"_name_": "shadow_inactive",
"title": "shadow_inactive",
"_required_": false,
"type": [
"string",
"null"
]
},
"shadow_expire": {
"_name_": "shadow_expire",
"title": "shadow_expire",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "shadow",
"title": "shadow",
"default": {},
"_required_": false,
"_attrs_order_": [
"shadow_object_class",
"shadow_last_change",
"shadow_min",
"shadow_max",
"shadow_warning",
"shadow_inactive",
"shadow_expire"
]
},
"group": {
"type": "object",
"properties": {
"group_object_class": {
"_name_": "group_object_class",
"title": "group_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"group_gid": {
"_name_": "group_gid",
"title": "group_gid",
"_required_": false,
"type": [
"string",
"null"
]
},
"group_member": {
"_name_": "group_member",
"title": "group_member",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "group",
"title": "group",
"default": {},
"_required_": false,
"_attrs_order_": [
"group_object_class",
"group_gid",
"group_member"
]
},
"netgroup": {
"type": "object",
"properties": {
"netgroup_object_class": {
"_name_": "netgroup_object_class",
"title": "netgroup_object_class",
"_required_": false,
"type": [
"string",
"null"
]
},
"netgroup_member": {
"_name_": "netgroup_member",
"title": "netgroup_member",
"_required_": false,
"type": [
"string",
"null"
]
},
"netgroup_triple": {
"_name_": "netgroup_triple",
"title": "netgroup_triple",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "netgroup",
"title": "netgroup",
"default": {},
"_required_": false,
"_attrs_order_": [
"netgroup_object_class",
"netgroup_member",
"netgroup_triple"
]
}
},
"additionalProperties": false,
"_name_": "attribute_maps",
"title": "attribute_maps",
"default": {},
"_required_": false,
"_attrs_order_": [
"passwd",
"shadow",
"group",
"netgroup"
],
"description": "`attribute_maps` - allow specifying alternate non-RFC-compliant\nattribute names for `passwd`, `shadow`, `group`, and `netgroup` object\nclasses as specified in RFC 2307. Setting key to `null` has special\nmeaning that RFC defaults for the configure `nss_info_schema` will\nbe used."
}
},
"additionalProperties": false,
"_name_": "ldap_update_returns",
"title": "ldap_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"hostname",
"basedn",
"binddn",
"bindpw",
"anonbind",
"ssl",
"certificate",
"validate_certificates",
"disable_freenas_cache",
"timeout",
"dns_timeout",
"kerberos_realm",
"kerberos_principal",
"auxiliary_parameters",
"schema",
"enable",
"search_bases",
"attribute_maps"
]
}
|
This method is accessible to the users granted with the following roles: DIRECTORY_SERVICE_WRITE |
The following are advanced settings are configuration parameters for handling LDAP servers that do not fully comply with RFC-2307. In most situations all of the following parameters should be set to null, which indicates to backend to use default for the specified NSS info schema.
|
mail.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"fromemail": {
"_name_": "fromemail",
"title": "fromemail",
"_required_": true,
"type": "string"
},
"fromname": {
"_name_": "fromname",
"title": "fromname",
"_required_": true,
"type": "string"
},
"outgoingserver": {
"_name_": "outgoingserver",
"title": "outgoingserver",
"_required_": true,
"type": "string"
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"security": {
"_name_": "security",
"title": "security",
"_required_": true,
"type": "string",
"enum": [
"PLAIN",
"SSL",
"TLS"
]
},
"smtp": {
"type": "boolean",
"_name_": "smtp",
"title": "smtp",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": [
"string",
"null"
]
},
"pass": {
"_name_": "pass",
"title": "pass",
"_required_": true,
"type": [
"string",
"null"
]
},
"oauth": {
"type": "object",
"properties": {
"client_id": {
"_name_": "client_id",
"title": "client_id",
"_required_": false,
"type": "string"
},
"client_secret": {
"_name_": "client_secret",
"title": "client_secret",
"_required_": false,
"type": "string"
},
"refresh_token": {
"_name_": "refresh_token",
"title": "refresh_token",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "oauth",
"title": "oauth",
"default": {},
"_required_": true,
"_attrs_order_": [
"client_id",
"client_secret",
"refresh_token"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "mail_entry",
"title": "mail_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"fromemail",
"fromname",
"outgoingserver",
"port",
"security",
"smtp",
"user",
"pass",
"oauth",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
mail.send |
---|
Arguments:
{
"type": "object",
"properties": {
"subject": {
"_name_": "subject",
"title": "subject",
"_required_": true,
"type": "string"
},
"text": {
"_name_": "text",
"title": "text",
"_required_": false,
"type": "string",
"description": "`text` will be formatted to HTML using Markdown and rendered using default E-Mail template."
},
"html": {
"_name_": "html",
"title": "html",
"_required_": false,
"type": [
"string",
"null"
],
"description": "You can put your own HTML using `html`. If `html` is null, no HTML MIME part will be added to E-Mail."
},
"to": {
"_name_": "to",
"title": "to",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "email",
"title": "email",
"_required_": false,
"type": "string"
}
]
},
"cc": {
"_name_": "cc",
"title": "cc",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "email",
"title": "email",
"_required_": false,
"type": "string"
}
]
},
"interval": {
"type": [
"integer",
"null"
],
"_name_": "interval",
"title": "interval",
"_required_": false
},
"channel": {
"_name_": "channel",
"title": "channel",
"_required_": false,
"type": [
"string",
"null"
]
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 300,
"_required_": false
},
"attachments": {
"type": "boolean",
"_name_": "attachments",
"title": "attachments",
"default": false,
"_required_": false,
"description": "If `attachments` is true, a list compromised of the following dict is required\nvia HTTP upload:\n - headers(list)\n - name(str)\n - value(str)\n - params(dict)\n - content (str)"
},
"queue": {
"type": "boolean",
"_name_": "queue",
"title": "queue",
"default": true,
"_required_": false
},
"extra_headers": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra_headers",
"title": "extra_headers",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "mail_message",
"title": "mail_message",
"default": {},
"_required_": false,
"_attrs_order_": [
"subject",
"text",
"html",
"to",
"cc",
"interval",
"channel",
"timeout",
"attachments",
"queue",
"extra_headers"
]
}
{
"type": "object",
"properties": {
"fromemail": {
"_name_": "fromemail",
"title": "fromemail",
"_required_": true,
"type": "string"
},
"fromname": {
"_name_": "fromname",
"title": "fromname",
"_required_": true,
"type": "string"
},
"outgoingserver": {
"_name_": "outgoingserver",
"title": "outgoingserver",
"_required_": true,
"type": "string"
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"security": {
"_name_": "security",
"title": "security",
"_required_": true,
"type": "string",
"enum": [
"PLAIN",
"SSL",
"TLS"
]
},
"smtp": {
"type": "boolean",
"_name_": "smtp",
"title": "smtp",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": [
"string",
"null"
]
},
"pass": {
"_name_": "pass",
"title": "pass",
"_required_": true,
"type": [
"string",
"null"
]
},
"oauth": {
"type": "object",
"properties": {
"client_id": {
"_name_": "client_id",
"title": "client_id",
"_required_": true,
"type": "string"
},
"client_secret": {
"_name_": "client_secret",
"title": "client_secret",
"_required_": true,
"type": "string"
},
"refresh_token": {
"_name_": "refresh_token",
"title": "refresh_token",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "oauth",
"title": "oauth",
"default": {},
"_required_": false,
"_attrs_order_": [
"client_id",
"client_secret",
"refresh_token"
]
}
},
"additionalProperties": false,
"_name_": "mail_update",
"title": "mail_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"fromemail",
"fromname",
"outgoingserver",
"port",
"security",
"smtp",
"user",
"pass",
"oauth"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successfully_sent",
"title": "successfully_sent",
"_required_": false
}
|
Sends mail using configured mail settings.
If [ { "headers": [ { "name": "Content-Transfer-Encoding", "value": "base64" }, { "name": "Content-Type", "value": "application/octet-stream", "params": { "name": "test.txt" } } ], "content": "dGVzdAo=" } ] |
mail.update |
---|
Arguments:
{
"type": "object",
"properties": {
"fromemail": {
"_name_": "fromemail",
"title": "fromemail",
"_required_": true,
"type": "string",
"description": "`fromemail` is used as a sending address which the mail server will use for sending emails."
},
"fromname": {
"_name_": "fromname",
"title": "fromname",
"_required_": true,
"type": "string"
},
"outgoingserver": {
"_name_": "outgoingserver",
"title": "outgoingserver",
"_required_": true,
"type": "string",
"description": "`outgoingserver` is the hostname or IP address of SMTP server used for sending an email."
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"security": {
"_name_": "security",
"title": "security",
"_required_": true,
"type": "string",
"enum": [
"PLAIN",
"SSL",
"TLS"
],
"description": "`security` is type of encryption desired."
},
"smtp": {
"type": "boolean",
"_name_": "smtp",
"title": "smtp",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": [
"string",
"null"
]
},
"pass": {
"_name_": "pass",
"title": "pass",
"_required_": true,
"type": [
"string",
"null"
]
},
"oauth": {
"type": "object",
"properties": {
"client_id": {
"_name_": "client_id",
"title": "client_id",
"_required_": true,
"type": "string"
},
"client_secret": {
"_name_": "client_secret",
"title": "client_secret",
"_required_": true,
"type": "string"
},
"refresh_token": {
"_name_": "refresh_token",
"title": "refresh_token",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "oauth",
"title": "oauth",
"default": {},
"_required_": false,
"_attrs_order_": [
"client_id",
"client_secret",
"refresh_token"
]
}
},
"additionalProperties": false,
"_name_": "mail_update",
"title": "mail_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"fromemail",
"fromname",
"outgoingserver",
"port",
"security",
"smtp",
"user",
"pass",
"oauth"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"fromemail": {
"_name_": "fromemail",
"title": "fromemail",
"_required_": true,
"type": "string",
"description": "`fromemail` is used as a sending address which the mail server will use for sending emails."
},
"fromname": {
"_name_": "fromname",
"title": "fromname",
"_required_": true,
"type": "string"
},
"outgoingserver": {
"_name_": "outgoingserver",
"title": "outgoingserver",
"_required_": true,
"type": "string",
"description": "`outgoingserver` is the hostname or IP address of SMTP server used for sending an email."
},
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"_required_": true
},
"security": {
"_name_": "security",
"title": "security",
"_required_": true,
"type": "string",
"enum": [
"PLAIN",
"SSL",
"TLS"
],
"description": "`security` is type of encryption desired."
},
"smtp": {
"type": "boolean",
"_name_": "smtp",
"title": "smtp",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": [
"string",
"null"
]
},
"pass": {
"_name_": "pass",
"title": "pass",
"_required_": true,
"type": [
"string",
"null"
]
},
"oauth": {
"type": "object",
"properties": {
"client_id": {
"_name_": "client_id",
"title": "client_id",
"_required_": false,
"type": "string"
},
"client_secret": {
"_name_": "client_secret",
"title": "client_secret",
"_required_": false,
"type": "string"
},
"refresh_token": {
"_name_": "refresh_token",
"title": "refresh_token",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "oauth",
"title": "oauth",
"default": {},
"_required_": true,
"_attrs_order_": [
"client_id",
"client_secret",
"refresh_token"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "mail_update_returns",
"title": "mail_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"fromemail",
"fromname",
"outgoingserver",
"port",
"security",
"smtp",
"user",
"pass",
"oauth",
"id"
]
}
|
Update Mail Service Configuration.
|
network.configuration.activity_choices |
---|
Return Arguments:
{
"_name_": "activity_choices",
"title": "activity_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "activity_choice",
"title": "activity_choice",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "activity",
"title": "activity",
"_required_": false,
"type": "string"
}
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns allowed/forbidden network activity choices. |
network.configuration.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": false,
"type": "string"
},
"ipv4gateway": {
"_name_": "ipv4gateway",
"title": "ipv4gateway",
"_required_": true,
"type": "string"
},
"ipv6gateway": {
"_name_": "ipv6gateway",
"title": "ipv6gateway",
"_required_": true,
"type": "string"
},
"nameserver1": {
"_name_": "nameserver1",
"title": "nameserver1",
"_required_": true,
"type": "string"
},
"nameserver2": {
"_name_": "nameserver2",
"title": "nameserver2",
"_required_": true,
"type": "string"
},
"nameserver3": {
"_name_": "nameserver3",
"title": "nameserver3",
"_required_": true,
"type": "string"
},
"httpproxy": {
"_name_": "httpproxy",
"title": "httpproxy",
"_required_": true,
"type": "string"
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"domains": {
"_name_": "domains",
"title": "domains",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "domain",
"title": "domain",
"_required_": false,
"type": "string"
}
]
},
"service_announcement": {
"type": "object",
"properties": {
"netbios": {
"type": "boolean",
"_name_": "netbios",
"title": "netbios",
"_required_": false
},
"mdns": {
"type": "boolean",
"_name_": "mdns",
"title": "mdns",
"_required_": false
},
"wsd": {
"type": "boolean",
"_name_": "wsd",
"title": "wsd",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service_announcement",
"title": "service_announcement",
"default": {},
"_required_": false,
"_attrs_order_": [
"netbios",
"mdns",
"wsd"
]
},
"activity": {
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"activities": {
"_name_": "activities",
"title": "activities",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "activity",
"title": "activity",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "activity",
"title": "activity",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"activities"
]
},
"hostname_local": {
"_name_": "hostname_local",
"title": "hostname_local",
"_required_": true,
"type": "string"
},
"hostname_b": {
"_name_": "hostname_b",
"title": "hostname_b",
"_required_": false,
"type": [
"string",
"null"
]
},
"hostname_virtual": {
"_name_": "hostname_virtual",
"title": "hostname_virtual",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"type": "object",
"properties": {
"ipv4gateway": {
"_name_": "ipv4gateway",
"title": "ipv4gateway",
"_required_": true,
"type": "string"
},
"ipv6gateway": {
"_name_": "ipv6gateway",
"title": "ipv6gateway",
"_required_": true,
"type": "string"
},
"nameserver1": {
"_name_": "nameserver1",
"title": "nameserver1",
"_required_": true,
"type": "string"
},
"nameserver2": {
"_name_": "nameserver2",
"title": "nameserver2",
"_required_": true,
"type": "string"
},
"nameserver3": {
"_name_": "nameserver3",
"title": "nameserver3",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipv4gateway",
"ipv6gateway",
"nameserver1",
"nameserver2",
"nameserver3"
]
}
},
"additionalProperties": false,
"_name_": "network_configuration_entry",
"title": "network_configuration_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"hostname",
"domain",
"ipv4gateway",
"ipv6gateway",
"nameserver1",
"nameserver2",
"nameserver3",
"httpproxy",
"hosts",
"domains",
"service_announcement",
"activity",
"hostname_local",
"hostname_b",
"hostname_virtual",
"state"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
network.configuration.update |
---|
Arguments:
{
"type": "object",
"properties": {
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": false,
"type": "string"
},
"ipv4gateway": {
"_name_": "ipv4gateway",
"title": "ipv4gateway",
"_required_": true,
"type": "string",
"description": "`ipv4gateway` if set is used instead of the default gateway provided by DHCP."
},
"ipv6gateway": {
"_name_": "ipv6gateway",
"title": "ipv6gateway",
"_required_": true,
"type": "string"
},
"nameserver1": {
"_name_": "nameserver1",
"title": "nameserver1",
"_required_": true,
"type": "string",
"description": "`nameserver1` is primary DNS server."
},
"nameserver2": {
"_name_": "nameserver2",
"title": "nameserver2",
"_required_": true,
"type": "string",
"description": "`nameserver2` is secondary DNS server."
},
"nameserver3": {
"_name_": "nameserver3",
"title": "nameserver3",
"_required_": true,
"type": "string",
"description": "`nameserver3` is tertiary DNS server."
},
"httpproxy": {
"_name_": "httpproxy",
"title": "httpproxy",
"_required_": true,
"type": "string",
"description": "`httpproxy` attribute must be provided if a proxy is to be used for network operations."
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"domains": {
"_name_": "domains",
"title": "domains",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "domain",
"title": "domain",
"_required_": false,
"type": "string"
}
]
},
"service_announcement": {
"type": "object",
"properties": {
"netbios": {
"type": "boolean",
"_name_": "netbios",
"title": "netbios",
"_required_": false
},
"mdns": {
"type": "boolean",
"_name_": "mdns",
"title": "mdns",
"_required_": false
},
"wsd": {
"type": "boolean",
"_name_": "wsd",
"title": "wsd",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service_announcement",
"title": "service_announcement",
"default": {},
"_required_": false,
"_attrs_order_": [
"netbios",
"mdns",
"wsd"
]
},
"activity": {
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"activities": {
"_name_": "activities",
"title": "activities",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "activity",
"title": "activity",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "activity",
"title": "activity",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"activities"
]
},
"hostname_b": {
"_name_": "hostname_b",
"title": "hostname_b",
"_required_": false,
"type": [
"string",
"null"
]
},
"hostname_virtual": {
"_name_": "hostname_virtual",
"title": "hostname_virtual",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "global_configuration_update",
"title": "global_configuration_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"hostname",
"domain",
"ipv4gateway",
"ipv6gateway",
"nameserver1",
"nameserver2",
"nameserver3",
"httpproxy",
"hosts",
"domains",
"service_announcement",
"activity",
"hostname_b",
"hostname_virtual"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": false,
"type": "string"
},
"ipv4gateway": {
"_name_": "ipv4gateway",
"title": "ipv4gateway",
"_required_": true,
"type": "string",
"description": "`ipv4gateway` if set is used instead of the default gateway provided by DHCP."
},
"ipv6gateway": {
"_name_": "ipv6gateway",
"title": "ipv6gateway",
"_required_": true,
"type": "string"
},
"nameserver1": {
"_name_": "nameserver1",
"title": "nameserver1",
"_required_": true,
"type": "string",
"description": "`nameserver1` is primary DNS server."
},
"nameserver2": {
"_name_": "nameserver2",
"title": "nameserver2",
"_required_": true,
"type": "string",
"description": "`nameserver2` is secondary DNS server."
},
"nameserver3": {
"_name_": "nameserver3",
"title": "nameserver3",
"_required_": true,
"type": "string",
"description": "`nameserver3` is tertiary DNS server."
},
"httpproxy": {
"_name_": "httpproxy",
"title": "httpproxy",
"_required_": true,
"type": "string",
"description": "`httpproxy` attribute must be provided if a proxy is to be used for network operations."
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"domains": {
"_name_": "domains",
"title": "domains",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "domain",
"title": "domain",
"_required_": false,
"type": "string"
}
]
},
"service_announcement": {
"type": "object",
"properties": {
"netbios": {
"type": "boolean",
"_name_": "netbios",
"title": "netbios",
"_required_": false
},
"mdns": {
"type": "boolean",
"_name_": "mdns",
"title": "mdns",
"_required_": false
},
"wsd": {
"type": "boolean",
"_name_": "wsd",
"title": "wsd",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service_announcement",
"title": "service_announcement",
"default": {},
"_required_": false,
"_attrs_order_": [
"netbios",
"mdns",
"wsd"
]
},
"activity": {
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"activities": {
"_name_": "activities",
"title": "activities",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "activity",
"title": "activity",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "activity",
"title": "activity",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"activities"
]
},
"hostname_local": {
"_name_": "hostname_local",
"title": "hostname_local",
"_required_": true,
"type": "string"
},
"hostname_b": {
"_name_": "hostname_b",
"title": "hostname_b",
"_required_": false,
"type": [
"string",
"null"
]
},
"hostname_virtual": {
"_name_": "hostname_virtual",
"title": "hostname_virtual",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"type": "object",
"properties": {
"ipv4gateway": {
"_name_": "ipv4gateway",
"title": "ipv4gateway",
"_required_": true,
"type": "string"
},
"ipv6gateway": {
"_name_": "ipv6gateway",
"title": "ipv6gateway",
"_required_": true,
"type": "string"
},
"nameserver1": {
"_name_": "nameserver1",
"title": "nameserver1",
"_required_": true,
"type": "string"
},
"nameserver2": {
"_name_": "nameserver2",
"title": "nameserver2",
"_required_": true,
"type": "string"
},
"nameserver3": {
"_name_": "nameserver3",
"title": "nameserver3",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipv4gateway",
"ipv6gateway",
"nameserver1",
"nameserver2",
"nameserver3"
]
}
},
"additionalProperties": false,
"_name_": "network_configuration_update_returns",
"title": "network_configuration_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"hostname",
"domain",
"ipv4gateway",
"ipv6gateway",
"nameserver1",
"nameserver2",
"nameserver3",
"httpproxy",
"hosts",
"domains",
"service_announcement",
"activity",
"hostname_local",
"hostname_b",
"hostname_virtual",
"state"
]
}
|
Update Network Configuration Service configuration.
|
network.general.summary |
---|
Return Arguments:
{
"type": "object",
"properties": {
"ips": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ips",
"title": "ips",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"default_routes": {
"_name_": "default_routes",
"title": "default_routes",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "default_route",
"title": "default_route",
"_required_": false,
"type": "string"
}
]
},
"nameservers": {
"_name_": "nameservers",
"title": "nameservers",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "nameserver",
"title": "nameserver",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "network_summary",
"title": "network_summary",
"default": {},
"_required_": false,
"_attrs_order_": [
"ips",
"default_routes",
"nameservers"
]
}
|
This method is accessible to the users granted with the following roles: NETWORK_GENERAL_READ, READONLY_ADMIN, SHARING_ADMIN |
Retrieve general information for current Network. Returns a dictionary. For example: |
|
nfs.bindip_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "bindip_choices",
"title": "bindip_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_NFS_READ, SHARING_NFS_WRITE, SHARING_READ, SHARING_WRITE |
Returns ip choices for NFS service to use |
nfs.client_count |
---|
Return Arguments:
{
"type": "integer",
"_name_": "number_of_clients",
"title": "number_of_clients",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_NFS_READ, SHARING_NFS_WRITE, SHARING_READ, SHARING_WRITE |
Return currently connected clients count. Count may not be accurate if NFSv3 protocol is in use due to potentially stale rmtab entries. |
nfs.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"servers": {
"type": [
"integer",
"null"
],
"_name_": "servers",
"title": "servers",
"_required_": true
},
"allow_nonroot": {
"type": "boolean",
"_name_": "allow_nonroot",
"title": "allow_nonroot",
"_required_": true
},
"protocols": {
"_name_": "protocols",
"title": "protocols",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string",
"enum": [
"NFSV3",
"NFSV4"
]
}
]
},
"v4_v3owner": {
"type": "boolean",
"_name_": "v4_v3owner",
"title": "v4_v3owner",
"_required_": true
},
"v4_krb": {
"type": "boolean",
"_name_": "v4_krb",
"title": "v4_krb",
"_required_": true
},
"v4_domain": {
"_name_": "v4_domain",
"title": "v4_domain",
"_required_": true,
"type": "string"
},
"bindip": {
"_name_": "bindip",
"title": "bindip",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
]
},
"mountd_port": {
"type": [
"integer",
"null"
],
"_name_": "mountd_port",
"title": "mountd_port",
"_required_": true
},
"rpcstatd_port": {
"type": [
"integer",
"null"
],
"_name_": "rpcstatd_port",
"title": "rpcstatd_port",
"_required_": true
},
"rpclockd_port": {
"type": [
"integer",
"null"
],
"_name_": "rpclockd_port",
"title": "rpclockd_port",
"_required_": true
},
"mountd_log": {
"type": "boolean",
"_name_": "mountd_log",
"title": "mountd_log",
"_required_": true
},
"statd_lockd_log": {
"type": "boolean",
"_name_": "statd_lockd_log",
"title": "statd_lockd_log",
"_required_": true
},
"v4_krb_enabled": {
"type": "boolean",
"_name_": "v4_krb_enabled",
"title": "v4_krb_enabled",
"_required_": true
},
"userd_manage_gids": {
"type": "boolean",
"_name_": "userd_manage_gids",
"title": "userd_manage_gids",
"_required_": true
},
"keytab_has_nfs_spn": {
"type": "boolean",
"_name_": "keytab_has_nfs_spn",
"title": "keytab_has_nfs_spn",
"_required_": true
},
"managed_nfsd": {
"type": "boolean",
"_name_": "managed_nfsd",
"title": "managed_nfsd",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "nfs_entry",
"title": "nfs_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"servers",
"allow_nonroot",
"protocols",
"v4_v3owner",
"v4_krb",
"v4_domain",
"bindip",
"mountd_port",
"rpcstatd_port",
"rpclockd_port",
"mountd_log",
"statd_lockd_log",
"v4_krb_enabled",
"userd_manage_gids",
"keytab_has_nfs_spn",
"managed_nfsd"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_NFS_READ, SHARING_NFS_WRITE, SHARING_READ, SHARING_WRITE |
- |
nfs.get_nfs3_clients |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_NFS_WRITE, SHARING_WRITE |
Read contents of rmtab. This information may not be accurate due to stale entries. This is ultimately a limitation of the NFSv3 protocol. |
nfs.get_nfs4_clients |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"info": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "info",
"title": "info",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "client",
"title": "client",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"info",
"state"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"info": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "info",
"title": "info",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "client",
"title": "client",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"info",
"state"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_NFS_WRITE, SHARING_WRITE |
Read information about NFSv4 clients from /proc/fs/nfsd/clients Sample output: [{ "id": "4", "info": { "clientid": 6273260596088110000, "address": "192.168.40.247:790", "status": "confirmed", "seconds from last renew": 45, "name": "Linux NFSv4.2 debian12-hv", "minor version": 2, "Implementation domain": "kernel.org", "Implementation name": "Linux 6.1.0-12-amd64 #1 SMP PREEMPT_DYNAMIC Debian 6.1.52-1 (2023-09-07) x86_64", "Implementation time": [0, 0], "callback state": "UP", "callback address": "192.168.40.247:0" }, "states": [ { "94850248556250062041657638912": { "type": "deleg", "access": "r", "superblock": "00:39:5", "filename": "/debian12-hv" } }, { "94850248556250062041741524992": { "type": "open", "access": "rw", "deny": "--", "superblock": "00:39:137", "filename": "/.debian12-hv.swp", "owner": "open id:8þÀ²3" } } ] }] ---- Description of the fields (all per NFS client) ---- 'clientid': Hash generated for this client connection 'address': The client IP and port. e.g. 10.20.30.40:768 'status': The current client status: 'confirmed' An active connection. The status will convert to 'courtesy' in 90 seconds if not 'confirmed' by the client. 'courtesy' A stalled connection from an inactive client. The status will convert to 'expirable' in 24hr. 'expirable' Waiting to be cleaned up. 'seconds from last renew': The session timeout counter. See 'status' field. Gets reset by confirmation update from the client 'name': Supplied by the client. Linux clients might offer something like 'Linux NFS4.2 clnt_name'. FreeBSD clients might supply a UUID like name 'minor version': The NFS4.x minor version. E.G. '2' for NFSv4.2 'Implementation domain': NFSv4.1 info - e.g. 'kernel.org' or 'freebsd.org'. 'Implementation name': NFSv4.1 info - e.g. equivalent to 'uname -a' on the client 'Implementation time': NFSv4.1 info - Timestamp (time nfstime4) of client version (maybe unused?) 'callback state': Current callback 'service' status for this client: 'UP', 'DOWN', 'FAULT' or 'UNKNOWN' Linux clients usually indicate 'UP' FreeBSD clients may indicate 'DOWN' but are still functional |
nfs.update |
---|
Arguments:
{
"type": "object",
"properties": {
"servers": {
"type": [
"integer",
"null"
],
"_name_": "servers",
"title": "servers",
"_required_": true,
"description": "`servers` - Represents number of servers to create.\n By default, the number of nfsd is determined by the capabilities of the system.\n To specify the number of nfsd, set a value between 1 and 256.\n 'Unset' the field to return to default.\n This field will always report the number of nfsd to start."
},
"allow_nonroot": {
"type": "boolean",
"_name_": "allow_nonroot",
"title": "allow_nonroot",
"_required_": true,
"description": "`allow_nonroot` - If 'enabled' it allows non-root mount requests to be served."
},
"protocols": {
"_name_": "protocols",
"title": "protocols",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string",
"enum": [
"NFSV3",
"NFSV4"
]
}
],
"description": "`protocols` - enable/disable NFSv3, NFSv4\n Both can be enabled or NFSv4 or NFSv4 by themselves. At least one must be enabled.\n Note: The 'showmount' command is available only if NFSv3 is enabled."
},
"v4_v3owner": {
"type": "boolean",
"_name_": "v4_v3owner",
"title": "v4_v3owner",
"_required_": true,
"description": "`v4_v3owner` - when set means that system will use NFSv3 ownership model for NFSv4.\n (Deprecated)"
},
"v4_krb": {
"type": "boolean",
"_name_": "v4_krb",
"title": "v4_krb",
"_required_": true,
"description": "`v4_krb` - Force Kerberos authentication on NFS shares\n If enabled, NFS shares will fail if the Kerberos ticket is unavilable"
},
"v4_domain": {
"_name_": "v4_domain",
"title": "v4_domain",
"_required_": true,
"type": "string",
"description": "`v4_domain` - Specify a DNS domain (NFSv4 only)\n If set, the value will be used to override the default DNS domain name for NFSv4.\n Specifies the 'Domain' idmapd.conf setting."
},
"bindip": {
"_name_": "bindip",
"title": "bindip",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
],
"description": "`bindip` - Limit the server IP addresses available for NFS\n By default, NFS will listen on all IP addresses that are active on the server.\n To specify the server interface or a set of interfaces provide a list of IP's.\n If the field is unset/empty, NFS listens on all available server addresses."
},
"mountd_port": {
"type": [
"integer",
"null"
],
"_name_": "mountd_port",
"title": "mountd_port",
"_required_": true,
"description": "`mountd_port` - mountd port binding\n The value set specifies the port mountd(8) binds to."
},
"rpcstatd_port": {
"type": [
"integer",
"null"
],
"_name_": "rpcstatd_port",
"title": "rpcstatd_port",
"_required_": true,
"description": "`rpcstatd_port` - statd port binding\n The value set specifies the port rpc.statd(8) binds to."
},
"rpclockd_port": {
"type": [
"integer",
"null"
],
"_name_": "rpclockd_port",
"title": "rpclockd_port",
"_required_": true,
"description": "`rpclockd_port` - lockd port binding\n The value set specifies the port rpclockd_port(8) binds to."
},
"mountd_log": {
"type": "boolean",
"_name_": "mountd_log",
"title": "mountd_log",
"_required_": true
},
"statd_lockd_log": {
"type": "boolean",
"_name_": "statd_lockd_log",
"title": "statd_lockd_log",
"_required_": true
},
"userd_manage_gids": {
"type": "boolean",
"_name_": "userd_manage_gids",
"title": "userd_manage_gids",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "nfs_update",
"title": "nfs_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"servers",
"allow_nonroot",
"protocols",
"v4_v3owner",
"v4_krb",
"v4_domain",
"bindip",
"mountd_port",
"rpcstatd_port",
"rpclockd_port",
"mountd_log",
"statd_lockd_log",
"userd_manage_gids"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"servers": {
"type": [
"integer",
"null"
],
"_name_": "servers",
"title": "servers",
"_required_": true,
"description": "`servers` - Represents number of servers to create.\n By default, the number of nfsd is determined by the capabilities of the system.\n To specify the number of nfsd, set a value between 1 and 256.\n 'Unset' the field to return to default.\n This field will always report the number of nfsd to start."
},
"allow_nonroot": {
"type": "boolean",
"_name_": "allow_nonroot",
"title": "allow_nonroot",
"_required_": true,
"description": "`allow_nonroot` - If 'enabled' it allows non-root mount requests to be served."
},
"protocols": {
"_name_": "protocols",
"title": "protocols",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string",
"enum": [
"NFSV3",
"NFSV4"
]
}
],
"description": "`protocols` - enable/disable NFSv3, NFSv4\n Both can be enabled or NFSv4 or NFSv4 by themselves. At least one must be enabled.\n Note: The 'showmount' command is available only if NFSv3 is enabled."
},
"v4_v3owner": {
"type": "boolean",
"_name_": "v4_v3owner",
"title": "v4_v3owner",
"_required_": true,
"description": "`v4_v3owner` - when set means that system will use NFSv3 ownership model for NFSv4.\n (Deprecated)"
},
"v4_krb": {
"type": "boolean",
"_name_": "v4_krb",
"title": "v4_krb",
"_required_": true,
"description": "`v4_krb` - Force Kerberos authentication on NFS shares\n If enabled, NFS shares will fail if the Kerberos ticket is unavilable"
},
"v4_domain": {
"_name_": "v4_domain",
"title": "v4_domain",
"_required_": true,
"type": "string",
"description": "`v4_domain` - Specify a DNS domain (NFSv4 only)\n If set, the value will be used to override the default DNS domain name for NFSv4.\n Specifies the 'Domain' idmapd.conf setting."
},
"bindip": {
"_name_": "bindip",
"title": "bindip",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
],
"description": "`bindip` - Limit the server IP addresses available for NFS\n By default, NFS will listen on all IP addresses that are active on the server.\n To specify the server interface or a set of interfaces provide a list of IP's.\n If the field is unset/empty, NFS listens on all available server addresses."
},
"mountd_port": {
"type": [
"integer",
"null"
],
"_name_": "mountd_port",
"title": "mountd_port",
"_required_": true,
"description": "`mountd_port` - mountd port binding\n The value set specifies the port mountd(8) binds to."
},
"rpcstatd_port": {
"type": [
"integer",
"null"
],
"_name_": "rpcstatd_port",
"title": "rpcstatd_port",
"_required_": true,
"description": "`rpcstatd_port` - statd port binding\n The value set specifies the port rpc.statd(8) binds to."
},
"rpclockd_port": {
"type": [
"integer",
"null"
],
"_name_": "rpclockd_port",
"title": "rpclockd_port",
"_required_": true,
"description": "`rpclockd_port` - lockd port binding\n The value set specifies the port rpclockd_port(8) binds to."
},
"mountd_log": {
"type": "boolean",
"_name_": "mountd_log",
"title": "mountd_log",
"_required_": true
},
"statd_lockd_log": {
"type": "boolean",
"_name_": "statd_lockd_log",
"title": "statd_lockd_log",
"_required_": true
},
"v4_krb_enabled": {
"type": "boolean",
"_name_": "v4_krb_enabled",
"title": "v4_krb_enabled",
"_required_": true
},
"userd_manage_gids": {
"type": "boolean",
"_name_": "userd_manage_gids",
"title": "userd_manage_gids",
"_required_": true
},
"keytab_has_nfs_spn": {
"type": "boolean",
"_name_": "keytab_has_nfs_spn",
"title": "keytab_has_nfs_spn",
"_required_": true
},
"managed_nfsd": {
"type": "boolean",
"_name_": "managed_nfsd",
"title": "managed_nfsd",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "nfs_update_returns",
"title": "nfs_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"servers",
"allow_nonroot",
"protocols",
"v4_v3owner",
"v4_krb",
"v4_domain",
"bindip",
"mountd_port",
"rpcstatd_port",
"rpclockd_port",
"mountd_log",
"statd_lockd_log",
"v4_krb_enabled",
"userd_manage_gids",
"keytab_has_nfs_spn",
"managed_nfsd"
]
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_NFS_WRITE, SHARING_WRITE |
Update NFS Service Configuration.
|
Update NFS Service Configuration to listen on 192.168.0.10 and use NFSv4
|
pool.attach
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "oid",
"title": "oid",
"_required_": false
}
{
"type": "object",
"properties": {
"target_vdev": {
"_name_": "target_vdev",
"title": "target_vdev",
"_required_": true,
"type": "string"
},
"new_disk": {
"_name_": "new_disk",
"title": "new_disk",
"_required_": true,
"type": "string"
},
"allow_duplicate_serials": {
"type": "boolean",
"_name_": "allow_duplicate_serials",
"title": "allow_duplicate_serials",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pool_attach",
"title": "pool_attach",
"default": {},
"_required_": false,
"_attrs_order_": [
"target_vdev",
"new_disk",
"allow_duplicate_serials"
]
}
|
|
pool.attachments |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"_name_": "attachments",
"title": "attachments",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"service": {
"_name_": "service",
"title": "service",
"_required_": true,
"type": [
"string",
"null"
]
},
"attachments": {
"_name_": "attachments",
"title": "attachments",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "attachment_name",
"title": "attachment_name",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "attachment",
"title": "attachment",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"service",
"attachments"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Return a list of services dependent of this pool. Responsible for telling the user whether there is a related share, asking for confirmation. |
pool.create
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool.\n`encryption_options` specifies configuration for encryption of root dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for root dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false,
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool."
},
"deduplication": {
"_name_": "deduplication",
"title": "deduplication",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
null,
"ON",
"VERIFY",
"OFF"
],
"description": "`deduplication` when set to ON or VERIFY makes sure that no block of data is duplicated in the pool. When\nVERIFY is specified, if two blocks have similar signatures, byte to byte comparison is performed to ensure that\nthe blocks are identical. This should be used in special circumstances as it carries a significant overhead."
},
"checksum": {
"_name_": "checksum",
"title": "checksum",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
null,
"ON",
"OFF",
"FLETCHER2",
"FLETCHER4",
"SHA256",
"SHA512",
"SKEIN",
"EDONR",
"BLAKE3"
]
},
"encryption_options": {
"type": "object",
"properties": {
"generate_key": {
"type": "boolean",
"_name_": "generate_key",
"title": "generate_key",
"default": false,
"_required_": false
},
"pbkdf2iters": {
"type": "integer",
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": 350000,
"_required_": false
},
"algorithm": {
"_name_": "algorithm",
"title": "algorithm",
"default": "AES-256-GCM",
"_required_": false,
"type": "string",
"enum": [
"AES-128-CCM",
"AES-192-CCM",
"AES-256-CCM",
"AES-128-GCM",
"AES-192-GCM",
"AES-256-GCM"
]
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"key": {
"_name_": "key",
"title": "key",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "encryption_options",
"title": "encryption_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"generate_key",
"pbkdf2iters",
"algorithm",
"passphrase",
"key"
],
"description": "`encryption_options` specifies configuration for encryption of root dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for root dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"DRAID1",
"DRAID2",
"DRAID3",
"RAIDZ1",
"RAIDZ2",
"RAIDZ3",
"MIRROR",
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
},
"draid_data_disks": {
"type": "integer",
"_name_": "draid_data_disks",
"title": "draid_data_disks",
"_required_": false
},
"draid_spare_disks": {
"type": "integer",
"_name_": "draid_spare_disks",
"title": "draid_spare_disks",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "datavdevs",
"title": "datavdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks",
"draid_data_disks",
"draid_spare_disks"
]
}
]
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"MIRROR",
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "specialvdevs",
"title": "specialvdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"MIRROR",
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "dedupvdevs",
"title": "dedupvdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "cachevdevs",
"title": "cachevdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"STRIPE",
"MIRROR"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "logvdevs",
"title": "logvdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"spares": {
"_name_": "spares",
"title": "spares",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"special",
"dedup",
"cache",
"log",
"spares"
],
"description": "`topology` is a object which requires at least one `data` entry.\nAll of `data` entries (vdevs) require to be of the same type.\nExample of `topology`:"
},
"allow_duplicate_serials": {
"type": "boolean",
"_name_": "allow_duplicate_serials",
"title": "allow_duplicate_serials",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pool_create",
"title": "pool_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"encryption",
"deduplication",
"checksum",
"encryption_options",
"topology",
"allow_duplicate_serials"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool.\n`encryption_options` specifies configuration for encryption of root dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for root dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
],
"description": "`topology` is a object which requires at least one `data` entry.\nAll of `data` entries (vdevs) require to be of the same type.\nExample of `topology`:"
}
},
"additionalProperties": false,
"_name_": "pool_create_returns",
"title": "pool_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
|
Create a new ZFS Pool.
It should be noted that keys are stored by the system for automatic locking/unlocking on import/export of encrypted datasets. If that is not desired, dataset should be created with a passphrase as a key. Example of
|
Create a pool named "tank", raidz1 with 3 disks, 1 cache disk, 1 ZIL/log disk and 1 hot spare disk.
|
pool.detach |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Detach a disk from pool of id `id`."
}
{
"type": "object",
"properties": {
"label": {
"_name_": "label",
"title": "label",
"_required_": true,
"type": "string",
"description": "`label` is the vdev guid or device name."
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"label"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "detached",
"title": "detached",
"_required_": false
}
|
Detach a disk from pool of id
|
Detach ZFS device.
|
pool.expand
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Expand pool to fit all available disk space. |
pool.export
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Export pool of `id`."
}
{
"type": "object",
"properties": {
"cascade": {
"type": "boolean",
"_name_": "cascade",
"title": "cascade",
"default": false,
"_required_": false,
"description": "`cascade` will delete all attachments of the given pool (`pool.attachments`)."
},
"restart_services": {
"type": "boolean",
"_name_": "restart_services",
"title": "restart_services",
"default": false,
"_required_": false,
"description": "`restart_services` will restart services that have open files on given pool."
},
"destroy": {
"type": "boolean",
"_name_": "destroy",
"title": "destroy",
"default": false,
"_required_": false,
"description": "`destroy` will also PERMANENTLY destroy the pool/data."
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"cascade",
"restart_services",
"destroy"
]
}
|
Export pool of
|
Export pool of id 1.
If this is an HA system and failover is enabled and the last zpool is exported/disconnected, then this will raise EOPNOTSUPP. Failover must be disabled before exporting the last zpool on the system. |
pool.filesystem_choices |
---|
Arguments:
{
"_name_": "types",
"title": "types",
"default": [
"FILESYSTEM",
"VOLUME"
],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"FILESYSTEM",
"VOLUME"
]
}
]
}
|
Return Arguments:
{
"_name_": "filesystem_choices",
"title": "filesystem_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "filesystem_name",
"title": "filesystem_name",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns all available datasets, except the following: 1. system datasets 2. application(s) internal datasets |
Get all datasets.
Get only filesystems (exclude volumes).
|
pool.get_disks |
---|
Arguments:
{
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"default": null,
"_required_": false
}
|
Return Arguments:
{
"_name_": "pool_disks",
"title": "pool_disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Get all disks in use by pools.
If |
pool.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
]
}
},
"additionalProperties": false,
"_name_": "pool_entry",
"title": "pool_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
pool.get_instance_by_name |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
]
}
},
"additionalProperties": false,
"_name_": "pool_entry",
"title": "pool_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
|
Returns pool with name |
pool.import_find
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Return Arguments:
{
"_name_": "pools_available_for_import",
"title": "Pools Available For Import",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_info",
"title": "pool_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"guid",
"status",
"hostname"
]
}
]
}
|
Returns a job id which can be used to retrieve a list of pools available for import with the following details as a result of the job: name, guid, status, hostname. |
pool.import_pool
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string",
"description": "If a `name` is specified the pool will be imported using that new name."
},
"enable_attachments": {
"type": "boolean",
"_name_": "enable_attachments",
"title": "enable_attachments",
"_required_": false,
"description": "If `enable_attachments` is set to true, attachments that were disabled during pool export will be\nre-enabled."
}
},
"additionalProperties": false,
"_name_": "pool_import",
"title": "pool_import",
"default": {},
"_required_": false,
"_attrs_order_": [
"guid",
"name",
"enable_attachments"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "successful_import",
"title": "successful_import",
"_required_": false
}
|
Import a pool found with If a If Errors: ENOENT - Pool not found |
Import pool of guid 5571830764813710860.
|
pool.is_upgraded |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns whether or not the pool of `id` is on the latest version and with all feature\nflags enabled."
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "pool_is_upgraded",
"title": "pool_is_upgraded",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns whether or not the pool of |
Check if pool of id 1 is upgraded.
|
pool.offline |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Offline a disk from pool of id `id`."
}
{
"type": "object",
"properties": {
"label": {
"_name_": "label",
"title": "label",
"_required_": true,
"type": "string",
"description": "`label` is the vdev guid or device name."
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"label"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "offline_successful",
"title": "offline_successful",
"_required_": false
}
|
Offline a disk from pool of id
|
Offline ZFS device.
|
pool.online |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Online a disk from pool of id `id`."
}
{
"type": "object",
"properties": {
"label": {
"_name_": "label",
"title": "label",
"_required_": true,
"type": "string",
"description": "`label` is the vdev guid or device name."
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"label"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "online_successful",
"title": "online_successful",
"_required_": false
}
|
Online a disk from pool of id
|
Online ZFS device.
|
pool.processes |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"_name_": "processes",
"title": "processes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"pid": {
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
},
"cmdline": {
"_name_": "cmdline",
"title": "cmdline",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "process",
"title": "process",
"default": {},
"_required_": false,
"_attrs_order_": [
"pid",
"name",
"service",
"cmdline"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns a list of running processes using this pool. |
pool.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
]
}
},
"additionalProperties": false,
"_name_": "pool_entry",
"title": "pool_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
]
}
},
"additionalProperties": false,
"_name_": "pool_entry",
"title": "pool_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
]
}
},
"additionalProperties": false,
"_name_": "pool_entry",
"title": "pool_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
pool.remove
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Remove a disk from pool of id `id`."
}
{
"type": "object",
"properties": {
"label": {
"_name_": "label",
"title": "label",
"_required_": true,
"type": "string",
"description": "`label` is the vdev guid or device name."
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"label"
]
}
|
Remove a disk from pool of id
Error codes:
|
Remove ZFS device.
|
pool.replace
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"label": {
"_name_": "label",
"title": "label",
"_required_": true,
"type": "string",
"description": "`label` is the ZFS guid or a device name"
},
"disk": {
"_name_": "disk",
"title": "disk",
"_required_": true,
"type": "string",
"description": "`disk` is the identifier of a disk"
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
},
"preserve_settings": {
"type": "boolean",
"_name_": "preserve_settings",
"title": "preserve_settings",
"default": true,
"_required_": false,
"description": "If `preserve_settings` is true, then settings (power management, S.M.A.R.T., etc.) of a disk being replaced\nwill be applied to a new disk."
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"label",
"disk",
"force",
"preserve_settings"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "replaced_successfully",
"title": "replaced_successfully",
"_required_": false
}
|
Replace a disk on a pool.
|
Replace missing ZFS device with disk {serial}FOO.
|
pool.scrub
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Performs a scrub action to pool of `id`."
}
{
"_name_": "action",
"title": "action",
"_required_": true,
"type": "string",
"enum": [
"START",
"STOP",
"PAUSE"
],
"description": "`action` can be either of \"START\", \"STOP\" or \"PAUSE\"."
}
|
Performs a scrub action to pool of
|
Start scrub on pool of id 1.
|
pool.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update pool of `id`, adding the new topology."
}
{
"type": "object",
"properties": {
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"DRAID1",
"DRAID2",
"DRAID3",
"RAIDZ1",
"RAIDZ2",
"RAIDZ3",
"MIRROR",
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
},
"draid_data_disks": {
"type": "integer",
"_name_": "draid_data_disks",
"title": "draid_data_disks",
"_required_": false
},
"draid_spare_disks": {
"type": "integer",
"_name_": "draid_spare_disks",
"title": "draid_spare_disks",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "datavdevs",
"title": "datavdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks",
"draid_data_disks",
"draid_spare_disks"
]
}
]
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"MIRROR",
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "specialvdevs",
"title": "specialvdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"MIRROR",
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "dedupvdevs",
"title": "dedupvdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"STRIPE"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "cachevdevs",
"title": "cachevdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"STRIPE",
"MIRROR"
]
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "logvdevs",
"title": "logvdevs",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"disks"
]
}
]
},
"spares": {
"_name_": "spares",
"title": "spares",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"special",
"dedup",
"cache",
"log",
"spares"
],
"description": "`topology` is a object which requires at least one `data` entry.\nAll of `data` entries (vdevs) require to be of the same type.\nExample of `topology`:"
},
"allow_duplicate_serials": {
"type": "boolean",
"_name_": "allow_duplicate_serials",
"title": "allow_duplicate_serials",
"default": false,
"_required_": false
},
"autotrim": {
"_name_": "autotrim",
"title": "autotrim",
"_required_": false,
"type": "string",
"enum": [
"ON",
"OFF"
]
}
},
"additionalProperties": false,
"_name_": "pool_update",
"title": "pool_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"topology",
"allow_duplicate_serials",
"autotrim"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update pool of `id`, adding the new topology."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool.\n`encryption_options` specifies configuration for encryption of root dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for root dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
],
"description": "`topology` is a object which requires at least one `data` entry.\nAll of `data` entries (vdevs) require to be of the same type.\nExample of `topology`:"
}
},
"additionalProperties": false,
"_name_": "pool_update_returns",
"title": "pool_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
|
Update pool of The |
Add a new set of raidz1 to pool of id 1.
|
pool.upgrade |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Upgrade pool of `id` to latest version with all feature flags."
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "upgraded",
"title": "upgraded",
"_required_": false
}
|
Upgrade pool of |
Upgrade pool of id 1.
|
pool.validate_name |
---|
Arguments:
{
"_name_": "pool_name",
"title": "pool_name",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Validates |
pool.dataset.attachments |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
}
|
Return Arguments:
{
"_name_": "attachments",
"title": "attachments",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"service": {
"_name_": "service",
"title": "service",
"_required_": true,
"type": [
"string",
"null"
]
},
"attachments": {
"_name_": "attachments",
"title": "attachments",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "attachment_name",
"title": "attachment_name",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "attachment",
"title": "attachment",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"service",
"attachments"
]
}
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return a list of services dependent of this dataset. Responsible for telling the user whether there is a related share, asking for confirmation. Example return value: [ { "type": "NFS Share", "service": "nfs", "attachments": ["/mnt/tank/work"] } ] |
pool.dataset.change_key |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Change encryption properties for `id` encrypted dataset."
}
{
"type": "object",
"properties": {
"generate_key": {
"type": "boolean",
"_name_": "generate_key",
"title": "generate_key",
"default": false,
"_required_": false
},
"key_file": {
"type": "boolean",
"_name_": "key_file",
"title": "key_file",
"default": false,
"_required_": false
},
"pbkdf2iters": {
"type": "integer",
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": 350000,
"_required_": false
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"key": {
"_name_": "key",
"title": "key",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "change_key_options",
"title": "change_key_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"generate_key",
"key_file",
"pbkdf2iters",
"passphrase",
"key"
]
}
|
Change encryption properties for Changing dataset encryption to use passphrase instead of a key is not allowed if: 1) It has encrypted roots as children which are encrypted with a key 2) If it is a root dataset where the system dataset is located |
pool.dataset.checksum_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"ON": {
"_name_": "ON",
"title": "ON",
"_required_": false,
"type": "string",
"enum": [
"ON"
]
},
"FLETCHER2": {
"_name_": "FLETCHER2",
"title": "FLETCHER2",
"_required_": false,
"type": "string",
"enum": [
"FLETCHER2"
]
},
"FLETCHER4": {
"_name_": "FLETCHER4",
"title": "FLETCHER4",
"_required_": false,
"type": "string",
"enum": [
"FLETCHER4"
]
},
"SHA256": {
"_name_": "SHA256",
"title": "SHA256",
"_required_": false,
"type": "string",
"enum": [
"SHA256"
]
},
"SHA512": {
"_name_": "SHA512",
"title": "SHA512",
"_required_": false,
"type": "string",
"enum": [
"SHA512"
]
},
"SKEIN": {
"_name_": "SKEIN",
"title": "SKEIN",
"_required_": false,
"type": "string",
"enum": [
"SKEIN"
]
},
"EDONR": {
"_name_": "EDONR",
"title": "EDONR",
"_required_": false,
"type": "string",
"enum": [
"EDONR"
]
},
"BLAKE3": {
"_name_": "BLAKE3",
"title": "BLAKE3",
"_required_": false,
"type": "string",
"enum": [
"BLAKE3"
]
}
},
"additionalProperties": false,
"_name_": "checksum_choices",
"title": "checksum_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"ON",
"FLETCHER2",
"FLETCHER4",
"SHA256",
"SHA512",
"SKEIN",
"EDONR",
"BLAKE3"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve checksums supported for ZFS dataset. |
pool.dataset.compression_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"ON": {
"_name_": "ON",
"title": "ON",
"_required_": false,
"type": "string",
"enum": [
"ON"
]
},
"OFF": {
"_name_": "OFF",
"title": "OFF",
"_required_": false,
"type": "string",
"enum": [
"OFF"
]
},
"LZ4": {
"_name_": "LZ4",
"title": "LZ4",
"_required_": false,
"type": "string",
"enum": [
"LZ4"
]
},
"GZIP": {
"_name_": "GZIP",
"title": "GZIP",
"_required_": false,
"type": "string",
"enum": [
"GZIP"
]
},
"GZIP-1": {
"_name_": "GZIP-1",
"title": "GZIP-1",
"_required_": false,
"type": "string",
"enum": [
"GZIP-1"
]
},
"GZIP-9": {
"_name_": "GZIP-9",
"title": "GZIP-9",
"_required_": false,
"type": "string",
"enum": [
"GZIP-9"
]
},
"ZSTD": {
"_name_": "ZSTD",
"title": "ZSTD",
"_required_": false,
"type": "string",
"enum": [
"ZSTD"
]
},
"ZSTD-FAST": {
"_name_": "ZSTD-FAST",
"title": "ZSTD-FAST",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST"
]
},
"ZLE": {
"_name_": "ZLE",
"title": "ZLE",
"_required_": false,
"type": "string",
"enum": [
"ZLE"
]
},
"LZJB": {
"_name_": "LZJB",
"title": "LZJB",
"_required_": false,
"type": "string",
"enum": [
"LZJB"
]
},
"ZSTD-1": {
"_name_": "ZSTD-1",
"title": "ZSTD-1",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-1"
]
},
"ZSTD-2": {
"_name_": "ZSTD-2",
"title": "ZSTD-2",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-2"
]
},
"ZSTD-3": {
"_name_": "ZSTD-3",
"title": "ZSTD-3",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-3"
]
},
"ZSTD-4": {
"_name_": "ZSTD-4",
"title": "ZSTD-4",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-4"
]
},
"ZSTD-5": {
"_name_": "ZSTD-5",
"title": "ZSTD-5",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-5"
]
},
"ZSTD-6": {
"_name_": "ZSTD-6",
"title": "ZSTD-6",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-6"
]
},
"ZSTD-7": {
"_name_": "ZSTD-7",
"title": "ZSTD-7",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-7"
]
},
"ZSTD-8": {
"_name_": "ZSTD-8",
"title": "ZSTD-8",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-8"
]
},
"ZSTD-9": {
"_name_": "ZSTD-9",
"title": "ZSTD-9",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-9"
]
},
"ZSTD-10": {
"_name_": "ZSTD-10",
"title": "ZSTD-10",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-10"
]
},
"ZSTD-11": {
"_name_": "ZSTD-11",
"title": "ZSTD-11",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-11"
]
},
"ZSTD-12": {
"_name_": "ZSTD-12",
"title": "ZSTD-12",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-12"
]
},
"ZSTD-13": {
"_name_": "ZSTD-13",
"title": "ZSTD-13",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-13"
]
},
"ZSTD-14": {
"_name_": "ZSTD-14",
"title": "ZSTD-14",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-14"
]
},
"ZSTD-15": {
"_name_": "ZSTD-15",
"title": "ZSTD-15",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-15"
]
},
"ZSTD-16": {
"_name_": "ZSTD-16",
"title": "ZSTD-16",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-16"
]
},
"ZSTD-17": {
"_name_": "ZSTD-17",
"title": "ZSTD-17",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-17"
]
},
"ZSTD-18": {
"_name_": "ZSTD-18",
"title": "ZSTD-18",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-18"
]
},
"ZSTD-19": {
"_name_": "ZSTD-19",
"title": "ZSTD-19",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-19"
]
},
"ZSTD-FAST-1": {
"_name_": "ZSTD-FAST-1",
"title": "ZSTD-FAST-1",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-1"
]
},
"ZSTD-FAST-2": {
"_name_": "ZSTD-FAST-2",
"title": "ZSTD-FAST-2",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-2"
]
},
"ZSTD-FAST-3": {
"_name_": "ZSTD-FAST-3",
"title": "ZSTD-FAST-3",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-3"
]
},
"ZSTD-FAST-4": {
"_name_": "ZSTD-FAST-4",
"title": "ZSTD-FAST-4",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-4"
]
},
"ZSTD-FAST-5": {
"_name_": "ZSTD-FAST-5",
"title": "ZSTD-FAST-5",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-5"
]
},
"ZSTD-FAST-6": {
"_name_": "ZSTD-FAST-6",
"title": "ZSTD-FAST-6",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-6"
]
},
"ZSTD-FAST-7": {
"_name_": "ZSTD-FAST-7",
"title": "ZSTD-FAST-7",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-7"
]
},
"ZSTD-FAST-8": {
"_name_": "ZSTD-FAST-8",
"title": "ZSTD-FAST-8",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-8"
]
},
"ZSTD-FAST-9": {
"_name_": "ZSTD-FAST-9",
"title": "ZSTD-FAST-9",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-9"
]
},
"ZSTD-FAST-10": {
"_name_": "ZSTD-FAST-10",
"title": "ZSTD-FAST-10",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-10"
]
},
"ZSTD-FAST-20": {
"_name_": "ZSTD-FAST-20",
"title": "ZSTD-FAST-20",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-20"
]
},
"ZSTD-FAST-30": {
"_name_": "ZSTD-FAST-30",
"title": "ZSTD-FAST-30",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-30"
]
},
"ZSTD-FAST-40": {
"_name_": "ZSTD-FAST-40",
"title": "ZSTD-FAST-40",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-40"
]
},
"ZSTD-FAST-50": {
"_name_": "ZSTD-FAST-50",
"title": "ZSTD-FAST-50",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-50"
]
},
"ZSTD-FAST-60": {
"_name_": "ZSTD-FAST-60",
"title": "ZSTD-FAST-60",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-60"
]
},
"ZSTD-FAST-70": {
"_name_": "ZSTD-FAST-70",
"title": "ZSTD-FAST-70",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-70"
]
},
"ZSTD-FAST-80": {
"_name_": "ZSTD-FAST-80",
"title": "ZSTD-FAST-80",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-80"
]
},
"ZSTD-FAST-90": {
"_name_": "ZSTD-FAST-90",
"title": "ZSTD-FAST-90",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-90"
]
},
"ZSTD-FAST-100": {
"_name_": "ZSTD-FAST-100",
"title": "ZSTD-FAST-100",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-100"
]
},
"ZSTD-FAST-500": {
"_name_": "ZSTD-FAST-500",
"title": "ZSTD-FAST-500",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-500"
]
},
"ZSTD-FAST-1000": {
"_name_": "ZSTD-FAST-1000",
"title": "ZSTD-FAST-1000",
"_required_": false,
"type": "string",
"enum": [
"ZSTD-FAST-1000"
]
}
},
"additionalProperties": false,
"_name_": "compression_choices",
"title": "compression_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"ON",
"OFF",
"LZ4",
"GZIP",
"GZIP-1",
"GZIP-9",
"ZSTD",
"ZSTD-FAST",
"ZLE",
"LZJB",
"ZSTD-1",
"ZSTD-2",
"ZSTD-3",
"ZSTD-4",
"ZSTD-5",
"ZSTD-6",
"ZSTD-7",
"ZSTD-8",
"ZSTD-9",
"ZSTD-10",
"ZSTD-11",
"ZSTD-12",
"ZSTD-13",
"ZSTD-14",
"ZSTD-15",
"ZSTD-16",
"ZSTD-17",
"ZSTD-18",
"ZSTD-19",
"ZSTD-FAST-1",
"ZSTD-FAST-2",
"ZSTD-FAST-3",
"ZSTD-FAST-4",
"ZSTD-FAST-5",
"ZSTD-FAST-6",
"ZSTD-FAST-7",
"ZSTD-FAST-8",
"ZSTD-FAST-9",
"ZSTD-FAST-10",
"ZSTD-FAST-20",
"ZSTD-FAST-30",
"ZSTD-FAST-40",
"ZSTD-FAST-50",
"ZSTD-FAST-60",
"ZSTD-FAST-70",
"ZSTD-FAST-80",
"ZSTD-FAST-90",
"ZSTD-FAST-100",
"ZSTD-FAST-500",
"ZSTD-FAST-1000"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve compression algorithm supported by ZFS. |
pool.dataset.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool.\nThere is 1 case where ZFS encryption is not allowed for a dataset:\n1) If the parent dataset is encrypted with a passphrase and `name` is being created\n with a key for encrypting the dataset.\n`encryption_options` specifies configuration for encryption of dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"type": {
"_name_": "type",
"title": "type",
"default": "FILESYSTEM",
"_required_": false,
"type": "string",
"enum": [
"FILESYSTEM",
"VOLUME"
]
},
"volsize": {
"type": "integer",
"_name_": "volsize",
"title": "volsize",
"_required_": false,
"description": "`volsize` is required for type=VOLUME and is supposed to be a multiple of the block size."
},
"volblocksize": {
"_name_": "volblocksize",
"title": "volblocksize",
"_required_": false,
"type": "string",
"enum": [
"512",
"512B",
"1K",
"2K",
"4K",
"8K",
"16K",
"32K",
"64K",
"128K"
],
"description": "`sparse` and `volblocksize` are only used for type=VOLUME."
},
"sparse": {
"type": "boolean",
"_name_": "sparse",
"title": "sparse",
"_required_": false,
"description": "`sparse` and `volblocksize` are only used for type=VOLUME."
},
"force_size": {
"type": "boolean",
"_name_": "force_size",
"title": "force_size",
"_required_": false
},
"comments": {
"_name_": "comments",
"title": "comments",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"sync": {
"_name_": "sync",
"title": "sync",
"_required_": false,
"enum": [
"STANDARD",
"ALWAYS",
"DISABLED"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"snapdev": {
"_name_": "snapdev",
"title": "snapdev",
"_required_": false,
"enum": [
"HIDDEN",
"VISIBLE"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"compression": {
"_name_": "compression",
"title": "compression",
"_required_": false,
"enum": [
"ON",
"OFF",
"LZ4",
"GZIP",
"GZIP-1",
"GZIP-9",
"ZSTD",
"ZSTD-FAST",
"ZLE",
"LZJB",
"ZSTD-1",
"ZSTD-2",
"ZSTD-3",
"ZSTD-4",
"ZSTD-5",
"ZSTD-6",
"ZSTD-7",
"ZSTD-8",
"ZSTD-9",
"ZSTD-10",
"ZSTD-11",
"ZSTD-12",
"ZSTD-13",
"ZSTD-14",
"ZSTD-15",
"ZSTD-16",
"ZSTD-17",
"ZSTD-18",
"ZSTD-19",
"ZSTD-FAST-1",
"ZSTD-FAST-2",
"ZSTD-FAST-3",
"ZSTD-FAST-4",
"ZSTD-FAST-5",
"ZSTD-FAST-6",
"ZSTD-FAST-7",
"ZSTD-FAST-8",
"ZSTD-FAST-9",
"ZSTD-FAST-10",
"ZSTD-FAST-20",
"ZSTD-FAST-30",
"ZSTD-FAST-40",
"ZSTD-FAST-50",
"ZSTD-FAST-60",
"ZSTD-FAST-70",
"ZSTD-FAST-80",
"ZSTD-FAST-90",
"ZSTD-FAST-100",
"ZSTD-FAST-500",
"ZSTD-FAST-1000"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"atime": {
"_name_": "atime",
"title": "atime",
"_required_": false,
"enum": [
"ON",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"exec": {
"_name_": "exec",
"title": "exec",
"_required_": false,
"enum": [
"ON",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"managedby": {
"_name_": "managedby",
"title": "managedby",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"quota": {
"type": [
"integer",
"null"
],
"_name_": "quota",
"title": "quota",
"_required_": false
},
"quota_warning": {
"_name_": "quota_warning",
"title": "quota_warning",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"quota_critical": {
"_name_": "quota_critical",
"title": "quota_critical",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"refquota": {
"type": [
"integer",
"null"
],
"_name_": "refquota",
"title": "refquota",
"_required_": false
},
"refquota_warning": {
"_name_": "refquota_warning",
"title": "refquota_warning",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"refquota_critical": {
"_name_": "refquota_critical",
"title": "refquota_critical",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"reservation": {
"type": "integer",
"_name_": "reservation",
"title": "reservation",
"_required_": false
},
"refreservation": {
"type": "integer",
"_name_": "refreservation",
"title": "refreservation",
"_required_": false
},
"special_small_block_size": {
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"copies": {
"_name_": "copies",
"title": "copies",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"snapdir": {
"_name_": "snapdir",
"title": "snapdir",
"_required_": false,
"enum": [
"VISIBLE",
"HIDDEN"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"deduplication": {
"_name_": "deduplication",
"title": "deduplication",
"_required_": false,
"enum": [
"ON",
"VERIFY",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"checksum": {
"_name_": "checksum",
"title": "checksum",
"_required_": false,
"enum": [
"ON",
"OFF",
"FLETCHER2",
"FLETCHER4",
"SHA256",
"SHA512",
"SKEIN",
"EDONR",
"BLAKE3"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"readonly": {
"_name_": "readonly",
"title": "readonly",
"_required_": false,
"enum": [
"ON",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"recordsize": {
"_name_": "recordsize",
"title": "recordsize",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"casesensitivity": {
"_name_": "casesensitivity",
"title": "casesensitivity",
"_required_": false,
"enum": [
"SENSITIVE",
"INSENSITIVE"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"aclmode": {
"_name_": "aclmode",
"title": "aclmode",
"_required_": false,
"enum": [
"PASSTHROUGH",
"RESTRICTED",
"DISCARD"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": false,
"enum": [
"OFF",
"NFSV4",
"POSIX"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"share_type": {
"_name_": "share_type",
"title": "share_type",
"default": "GENERIC",
"_required_": false,
"type": "string",
"enum": [
"GENERIC",
"MULTIPROTOCOL",
"NFS",
"SMB",
"APPS"
]
},
"xattr": {
"_name_": "xattr",
"title": "xattr",
"default": "SA",
"_required_": false,
"enum": [
"ON",
"SA"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"encryption_options": {
"type": "object",
"properties": {
"generate_key": {
"type": "boolean",
"_name_": "generate_key",
"title": "generate_key",
"default": false,
"_required_": false
},
"pbkdf2iters": {
"type": "integer",
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": 350000,
"_required_": false
},
"algorithm": {
"_name_": "algorithm",
"title": "algorithm",
"default": "AES-256-GCM",
"_required_": false,
"type": "string",
"enum": [
"AES-128-CCM",
"AES-192-CCM",
"AES-256-CCM",
"AES-128-GCM",
"AES-192-GCM",
"AES-256-GCM"
]
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"key": {
"_name_": "key",
"title": "key",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "encryption_options",
"title": "encryption_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"generate_key",
"pbkdf2iters",
"algorithm",
"passphrase",
"key"
],
"description": "`encryption_options` specifies configuration for encryption of dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false,
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool.\nThere is 1 case where ZFS encryption is not allowed for a dataset:\n1) If the parent dataset is encrypted with a passphrase and `name` is being created\n with a key for encrypting the dataset."
},
"inherit_encryption": {
"type": "boolean",
"_name_": "inherit_encryption",
"title": "inherit_encryption",
"default": true,
"_required_": false
},
"user_properties": {
"_name_": "user_properties",
"title": "user_properties",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"key": {
"_name_": "key",
"title": "key",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "user_property",
"title": "user_property",
"default": {},
"_required_": false,
"_attrs_order_": [
"key",
"value"
]
}
]
},
"create_ancestors": {
"type": "boolean",
"_name_": "create_ancestors",
"title": "create_ancestors",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pool_dataset_create",
"title": "pool_dataset_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"volsize",
"volblocksize",
"sparse",
"force_size",
"comments",
"sync",
"snapdev",
"compression",
"atime",
"exec",
"managedby",
"quota",
"quota_warning",
"quota_critical",
"refquota",
"refquota_warning",
"refquota_critical",
"reservation",
"refreservation",
"special_small_block_size",
"copies",
"snapdir",
"deduplication",
"checksum",
"readonly",
"recordsize",
"casesensitivity",
"aclmode",
"acltype",
"share_type",
"xattr",
"encryption_options",
"encryption",
"inherit_encryption",
"user_properties",
"create_ancestors"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool.\nThere is 1 case where ZFS encryption is not allowed for a dataset:\n1) If the parent dataset is encrypted with a passphrase and `name` is being created\n with a key for encrypting the dataset.\n`encryption_options` specifies configuration for encryption of dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"encrypted": {
"type": "boolean",
"_name_": "encrypted",
"title": "encrypted",
"_required_": false
},
"encryption_root": {
"_name_": "encryption_root",
"title": "encryption_root",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_loaded": {
"type": [
"boolean",
"null"
],
"_name_": "key_loaded",
"title": "key_loaded",
"_required_": false
},
"children": {
"_name_": "children",
"title": "children",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"user_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "user_properties",
"title": "user_properties",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"comments": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "comments",
"title": "comments",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_warning",
"title": "quota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_critical",
"title": "quota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_warning",
"title": "refquota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_critical",
"title": "refquota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"managedby": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "managedby",
"title": "managedby",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"deduplication": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "deduplication",
"title": "deduplication",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"aclmode": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "aclmode",
"title": "aclmode",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"acltype": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltype",
"title": "acltype",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"xattr": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "xattr",
"title": "xattr",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"atime": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "atime",
"title": "atime",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"casesensitivity": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "casesensitivity",
"title": "casesensitivity",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"checksum": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "checksum",
"title": "checksum",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"exec": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exec",
"title": "exec",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sync": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sync",
"title": "sync",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compression": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compression",
"title": "compression",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compressratio": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compressratio",
"title": "compressratio",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"origin": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "origin",
"title": "origin",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota",
"title": "quota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota",
"title": "refquota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"reservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reservation",
"title": "reservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refreservation",
"title": "refreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"copies": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "copies",
"title": "copies",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdir": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdir",
"title": "snapdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"readonly": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "readonly",
"title": "readonly",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"recordsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "recordsize",
"title": "recordsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sparse": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sparse",
"title": "sparse",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
],
"description": "`sparse` and `volblocksize` are only used for type=VOLUME."
},
"volsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volsize",
"title": "volsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
],
"description": "`volsize` is required for type=VOLUME and is supposed to be a multiple of the block size."
},
"volblocksize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volblocksize",
"title": "volblocksize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
],
"description": "`sparse` and `volblocksize` are only used for type=VOLUME."
},
"key_format": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "key_format",
"title": "key_format",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"encryption_algorithm": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm",
"title": "encryption_algorithm",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"used": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "used",
"title": "used",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbychildren": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbychildren",
"title": "usedbychildren",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbydataset": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbydataset",
"title": "usedbydataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbyrefreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbyrefreservation",
"title": "usedbyrefreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbysnapshots": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbysnapshots",
"title": "usedbysnapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"available": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "available",
"title": "available",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"special_small_block_size": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"pbkdf2iters": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"creation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "creation",
"title": "creation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdev": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdev",
"title": "snapdev",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_create_returns",
"title": "pool_dataset_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"pool",
"encrypted",
"encryption_root",
"key_loaded",
"children",
"user_properties",
"locked",
"comments",
"quota_warning",
"quota_critical",
"refquota_warning",
"refquota_critical",
"managedby",
"deduplication",
"aclmode",
"acltype",
"xattr",
"atime",
"casesensitivity",
"checksum",
"exec",
"sync",
"compression",
"compressratio",
"origin",
"quota",
"refquota",
"reservation",
"refreservation",
"copies",
"snapdir",
"readonly",
"recordsize",
"sparse",
"volsize",
"volblocksize",
"key_format",
"encryption_algorithm",
"used",
"usedbychildren",
"usedbydataset",
"usedbyrefreservation",
"usedbysnapshots",
"available",
"special_small_block_size",
"pbkdf2iters",
"creation",
"snapdev",
"mountpoint"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_WRITE, SHARING_ADMIN |
Creates a dataset/zvol.
It should be noted that keys are stored by the system for automatic locking/unlocking on import/export of encrypted datasets. If that is not desired, dataset should be created with a passphrase as a key. |
Create a dataset within tank pool.
|
pool.dataset.delete |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Delete dataset/zvol `id`.\nWhen root dataset is specified as `id` with `recursive`, it will destroy all the children of the\nroot dataset present leaving root dataset intact."
}
{
"type": "object",
"properties": {
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false,
"description": "`recursive` will also delete/destroy all children datasets.\nWhen root dataset is specified as `id` with `recursive`, it will destroy all the children of the\nroot dataset present leaving root dataset intact."
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false,
"description": "`force` will force delete busy datasets."
}
},
"additionalProperties": false,
"_name_": "dataset_delete",
"title": "dataset_delete",
"default": {},
"_required_": false,
"_attrs_order_": [
"recursive",
"force"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DATASET_DELETE |
Delete dataset/zvol
When root dataset is specified as |
Delete "tank/myuser" dataset.
|
pool.dataset.destroy_snapshots
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"all": {
"type": "boolean",
"_name_": "all",
"title": "all",
"default": true,
"_required_": false
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
},
"snapshots": {
"_name_": "snapshots",
"title": "snapshots",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"start": {
"_name_": "start",
"title": "start",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "snapshot_spec",
"title": "snapshot_spec",
"default": {},
"_required_": false,
"_attrs_order_": [
"start",
"end"
]
},
{
"_name_": "snapshot_name",
"title": "snapshot_name",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "snapshots",
"title": "snapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"all",
"recursive",
"snapshots"
]
}
|
Return Arguments:
{
"_name_": "deleted_snapshots",
"title": "deleted_snapshots",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "deleted_snapshot",
"title": "deleted_snapshot",
"_required_": false,
"type": "string"
}
]
}
|
Destroy specified snapshots of a given dataset. |
pool.dataset.details |
---|
Return Arguments:
{
"_name_": "dataset_details",
"title": "dataset_details",
"description": "\n\nExample(s):\n```\n[\n {\n \"id\": \"tank\",\n \"type\": \"FILESYSTEM\",\n \"name\": \"tank\",\n \"pool\": \"tank\",\n \"encrypted\": false,\n \"encryption_root\": null,\n \"key_loaded\": false,\n \"children\": [\n {\n \"id\": \"tank/soemthing\",\n \"type\": \"VOLUME\",\n \"name\": \"tank/soemthing\",\n \"pool\": \"tank\",\n \"encrypted\": false,\n \"encryption_root\": null,\n \"key_loaded\": false,\n \"children\": [],\n \"managed_by\": {\n \"value\": \"10.231.1.155\",\n \"rawvalue\": \"10.231.1.155\",\n \"source\": \"LOCAL\",\n \"parsed\": \"10.231.1.155\"\n },\n \"quota_warning\": {\n \"value\": \"80\",\n \"rawvalue\": \"80\",\n \"source\": \"LOCAL\",\n \"parsed\": \"80\"\n },\n \"quota_critical\": {\n \"value\": \"95\",\n \"rawvalue\": \"95\",\n \"source\": \"LOCAL\",\n \"parsed\": \"95\"\n },\n \"refquota_warning\": {\n \"value\": \"80\",\n \"rawvalue\": \"80\",\n \"source\": \"LOCAL\",\n \"parsed\": \"80\"\n },\n \"refquota_critical\": {\n \"value\": \"95\",\n \"rawvalue\": \"95\",\n \"source\": \"LOCAL\",\n \"parsed\": \"95\"\n },\n \"reservation\": {\n \"parsed\": null,\n \"rawvalue\": \"0\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"refreservation\": {\n \"parsed\": null,\n \"rawvalue\": \"0\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"key_format\": {\n \"parsed\": \"none\",\n \"rawvalue\": \"none\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"volsize\": {\n \"parsed\": 57344,\n \"rawvalue\": \"57344\",\n \"value\": \"56K\",\n \"source\": \"LOCAL\",\n \"source_info\": null\n },\n \"encryption_algorithm\": {\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"used\": {\n \"parsed\": 57344,\n \"rawvalue\": \"57344\",\n \"value\": \"56K\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"usedbychildren\": {\n \"parsed\": 0,\n \"rawvalue\": \"0\",\n \"value\": \"0B\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"usedbydataset\": {\n \"parsed\": 57344,\n \"rawvalue\": \"57344\",\n \"value\": \"56K\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"usedbysnapshots\": {\n \"parsed\": 0,\n \"rawvalue\": \"0\",\n \"value\": \"0B\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"available\": {\n \"parsed\": 14328811520,\n \"rawvalue\": \"14328811520\",\n \"value\": \"13.3G\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"mountpoint\": \"/mnt/tank/something\",\n \"sync\": {\n \"parsed\": \"standard\",\n \"rawvalue\": \"standard\",\n \"value\": \"STANDARD\",\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"compression\": {\n \"parsed\": \"lz4\",\n \"rawvalue\": \"lz4\",\n \"value\": \"LZ4\",\n \"source\": \"INHERITED\",\n \"source_info\": \"tank\"\n },\n \"deduplication\": {\n \"parsed\": \"on\",\n \"rawvalue\": \"on\",\n \"value\": \"ON\",\n \"source\": \"LOCAL\",\n \"source_info\": null\n },\n \"user_properties\": {},\n \"snapshot_count\": 0,\n \"locked\": false,\n \"thick_provisioned\": true,\n \"nfs_shares\": [\n {\n \"enabled\": true,\n \"path\": \"/mnt/tank/something\"\n }\n ],\n \"smb_shares\": [\n {\n \"enabled\": false,\n \"path\": \"/mnt/tank/something/smbshare01\",\n \"share_name\": \"Home Pictures\"\n }\n ],\n \"iscsi_shares\": [\n {\n \"enabled\": false,\n \"type\": \"DISK\",\n \"path\": \"/mnt/tank/something\"\n }\n ],\n \"vms\": [\n {\n \"name\": \"deb01\",\n \"path\": \"/dev/zvol/tank/something\"\n }\n ],\n \"apps\": [\n {\n \"name\": \"diskoverdata\",\n \"path\": \"/mnt/tank/something\"\n }\n ],\n \"replication_tasks_count\": 0,\n \"snapshot_tasks_count\": 0,\n \"cloudsync_tasks_count\": 0,\n \"rsync_tasks_count\": 0\n }\n ],\n \"mountpoint\": \"/mnt/tank\",\n \"quota\": {\n \"parsed\": null,\n \"rawvalue\": \"0\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"refquota\": {\n \"parsed\": null,\n \"rawvalue\": \"0\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"reservation\": {\n \"parsed\": null,\n \"rawvalue\": \"0\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"refreservation\": {\n \"parsed\": null,\n \"rawvalue\": \"0\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"encryption_algorithm\": {\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"value\": null,\n \"source\": \"DEFAULT\",\n \"source_info\": null\n },\n \"origin\": {\n \"parsed\": \"\",\n \"rawvalue\": \"\",\n \"value\": \"\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"used\": {\n \"parsed\": 3874467840,\n \"rawvalue\": \"3874467840\",\n \"value\": \"3.61G\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"usedbychildren\": {\n \"parsed\": 3874369536,\n \"rawvalue\": \"3874369536\",\n \"value\": \"3.61G\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"usedbydataset\": {\n \"parsed\": 98304,\n \"rawvalue\": \"98304\",\n \"value\": \"96K\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"usedbysnapshots\": {\n \"parsed\": 0,\n \"rawvalue\": \"0\",\n \"value\": \"0B\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"available\": {\n \"parsed\": 14328811520,\n \"rawvalue\": \"14328811520\",\n \"value\": \"13.3G\",\n \"source\": \"NONE\",\n \"source_info\": null\n },\n \"user_properties\": {},\n \"snapshot_count\": 0,\n \"locked\": false,\n \"atime\": false,\n \"casesensitive\": true,\n \"readonly\": false,\n \"nfs_shares\": [],\n \"smb_shares\": [],\n \"iscsi_shares\": [],\n \"vms\": [],\n \"apps\": [\n {\n \"name\": \"plex\",\n \"path\": \"/mnt/evo/data\"\n }\n ],\n \"replication_tasks_count\": 0,\n \"snapshot_tasks_count\": 0,\n \"cloudsync_tasks_count\": 0,\n \"rsync_tasks_count\": 0\n }\n]\n```\n",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve all dataset(s) details outlining any services/tasks which might be consuming the dataset(s). |
pool.dataset.encryption_algorithm_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"AES-128-CCM": {
"_name_": "AES-128-CCM",
"title": "AES-128-CCM",
"_required_": false,
"type": "string",
"enum": [
"AES-128-CCM"
]
},
"AES-192-CCM": {
"_name_": "AES-192-CCM",
"title": "AES-192-CCM",
"_required_": false,
"type": "string",
"enum": [
"AES-192-CCM"
]
},
"AES-256-CCM": {
"_name_": "AES-256-CCM",
"title": "AES-256-CCM",
"_required_": false,
"type": "string",
"enum": [
"AES-256-CCM"
]
},
"AES-128-GCM": {
"_name_": "AES-128-GCM",
"title": "AES-128-GCM",
"_required_": false,
"type": "string",
"enum": [
"AES-128-GCM"
]
},
"AES-192-GCM": {
"_name_": "AES-192-GCM",
"title": "AES-192-GCM",
"_required_": false,
"type": "string",
"enum": [
"AES-192-GCM"
]
},
"AES-256-GCM": {
"_name_": "AES-256-GCM",
"title": "AES-256-GCM",
"_required_": false,
"type": "string",
"enum": [
"AES-256-GCM"
]
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm_choices",
"title": "encryption_algorithm_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"AES-128-CCM",
"AES-192-CCM",
"AES-256-CCM",
"AES-128-GCM",
"AES-192-GCM",
"AES-256-GCM"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve encryption algorithms supported for ZFS dataset encryption. |
pool.dataset.encryption_summary |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Retrieve summary of all encrypted roots under `id`.\nIt should be noted that there are 2 keys which show if a recursive unlock operation is\ndone for `id`, which dataset will be unlocked and if not why it won't be unlocked. The keys\nnamely are \"unlock_successful\" and \"unlock_error\". The former is a boolean value showing if unlock\nwould succeed/fail. The latter is description why it failed if it failed."
}
{
"type": "object",
"properties": {
"key_file": {
"type": "boolean",
"_name_": "key_file",
"title": "key_file",
"default": false,
"_required_": false
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
},
"datasets": {
"_name_": "datasets",
"title": "datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"key": {
"_name_": "key",
"title": "key",
"_required_": false,
"type": "string"
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "dataset",
"title": "dataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"force",
"name",
"key",
"passphrase"
]
}
]
}
},
"additionalProperties": false,
"_name_": "encryption_root_summary_options",
"title": "encryption_root_summary_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"key_file",
"force",
"datasets"
]
}
|
Return Arguments:
{
"_name_": "encryption_summary",
"title": "encryption_summary",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"key_format": {
"_name_": "key_format",
"title": "key_format",
"_required_": true,
"type": "string"
},
"key_present_in_database": {
"type": "boolean",
"_name_": "key_present_in_database",
"title": "key_present_in_database",
"_required_": true
},
"valid_key": {
"type": "boolean",
"_name_": "valid_key",
"title": "valid_key",
"_required_": true
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": true
},
"unlock_error": {
"_name_": "unlock_error",
"title": "unlock_error",
"_required_": true,
"type": [
"string",
"null"
]
},
"unlock_successful": {
"type": "boolean",
"_name_": "unlock_successful",
"title": "unlock_successful",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "dataset_encryption_summary",
"title": "dataset_encryption_summary",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"key_format",
"key_present_in_database",
"valid_key",
"locked",
"unlock_error",
"unlock_successful"
]
}
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve summary of all encrypted roots under Keys/passphrase can be supplied to check if the keys are valid. It should be noted that there are 2 keys which show if a recursive unlock operation is
done for In some cases it's possible that the provided key/passphrase is valid but the path where the dataset is
supposed to be mounted after being unlocked already exists and is not empty. In this case, unlock operation
would fail and If a dataset is already unlocked, it will show up as true for "unlock_successful" regardless of what key user provided as the unlock keys in the output are to reflect what a real unlock operation would behave. If user is interested in seeing if a provided key is valid or not, then the key to look out for in the output is "valid_key" which based on what system has in database or if a user provided one, validates the key and sets a boolean value for the dataset. Example output: [ { "name": "vol", "key_format": "PASSPHRASE", "key_present_in_database": false, "valid_key": true, "locked": true, "unlock_error": null, "unlock_successful": true }, { "name": "vol/c1/d1", "key_format": "PASSPHRASE", "key_present_in_database": false, "valid_key": false, "locked": true, "unlock_error": "Provided key is invalid", "unlock_successful": false }, { "name": "vol/c", "key_format": "PASSPHRASE", "key_present_in_database": false, "valid_key": false, "locked": true, "unlock_error": "Key not provided", "unlock_successful": false }, { "name": "vol/c/d2", "key_format": "PASSPHRASE", "key_present_in_database": false, "valid_key": false, "locked": true, "unlock_error": "Child cannot be unlocked when parent "vol/c" is locked and provided key is invalid", "unlock_successful": false } ] |
pool.dataset.export_key |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Export own encryption key for dataset `id`. If `download` is `true`, key will be downloaded in a json file\nwhere the same file can be used to unlock the dataset, otherwise it will be returned as string."
}
{
"type": "boolean",
"_name_": "download",
"title": "download",
"default": false,
"_required_": false,
"description": "Export own encryption key for dataset `id`. If `download` is `true`, key will be downloaded in a json file\nwhere the same file can be used to unlock the dataset, otherwise it will be returned as string."
}
|
Return Arguments:
{
"_name_": "key",
"title": "key",
"_required_": false,
"type": [
"string",
"null"
]
}
|
Export own encryption key for dataset Please refer to websocket documentation for downloading the file. |
pool.dataset.export_keys |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Export keys for `id` and its children which are stored in the system. The exported file is a JSON file\nwhich has a dictionary containing dataset names as keys and their keys as the value."
}
|
This method is accessible to the users granted with the following roles: DATASET_WRITE, REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL, SHARING_ADMIN |
Export keys for Please refer to websocket documentation for downloading the file. |
pool.dataset.export_keys_for_replication |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Export keys for replication task `id` for source dataset(s) which are stored in the system. The exported file\nis a JSON file which has a dictionary containing dataset names as keys and their keys as the value."
}
|
This method is accessible to the users granted with the following roles: DATASET_WRITE, REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL, SHARING_ADMIN |
Export keys for replication task Please refer to websocket documentation for downloading the file. |
pool.dataset.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string",
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"encrypted": {
"type": "boolean",
"_name_": "encrypted",
"title": "encrypted",
"_required_": false
},
"encryption_root": {
"_name_": "encryption_root",
"title": "encryption_root",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_loaded": {
"type": [
"boolean",
"null"
],
"_name_": "key_loaded",
"title": "key_loaded",
"_required_": false
},
"children": {
"_name_": "children",
"title": "children",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"user_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "user_properties",
"title": "user_properties",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"comments": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "comments",
"title": "comments",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_warning",
"title": "quota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_critical",
"title": "quota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_warning",
"title": "refquota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_critical",
"title": "refquota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"managedby": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "managedby",
"title": "managedby",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"deduplication": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "deduplication",
"title": "deduplication",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"aclmode": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "aclmode",
"title": "aclmode",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"acltype": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltype",
"title": "acltype",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"xattr": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "xattr",
"title": "xattr",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"atime": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "atime",
"title": "atime",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"casesensitivity": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "casesensitivity",
"title": "casesensitivity",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"checksum": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "checksum",
"title": "checksum",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"exec": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exec",
"title": "exec",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sync": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sync",
"title": "sync",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compression": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compression",
"title": "compression",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compressratio": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compressratio",
"title": "compressratio",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"origin": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "origin",
"title": "origin",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota",
"title": "quota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota",
"title": "refquota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"reservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reservation",
"title": "reservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refreservation",
"title": "refreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"copies": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "copies",
"title": "copies",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdir": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdir",
"title": "snapdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"readonly": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "readonly",
"title": "readonly",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"recordsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "recordsize",
"title": "recordsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sparse": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sparse",
"title": "sparse",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volsize",
"title": "volsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volblocksize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volblocksize",
"title": "volblocksize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"key_format": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "key_format",
"title": "key_format",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"encryption_algorithm": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm",
"title": "encryption_algorithm",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"used": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "used",
"title": "used",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbychildren": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbychildren",
"title": "usedbychildren",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbydataset": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbydataset",
"title": "usedbydataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbyrefreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbyrefreservation",
"title": "usedbyrefreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbysnapshots": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbysnapshots",
"title": "usedbysnapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"available": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "available",
"title": "available",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"special_small_block_size": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"pbkdf2iters": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"creation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "creation",
"title": "creation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdev": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdev",
"title": "snapdev",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_entry",
"title": "pool_dataset_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"pool",
"encrypted",
"encryption_root",
"key_loaded",
"children",
"user_properties",
"locked",
"comments",
"quota_warning",
"quota_critical",
"refquota_warning",
"refquota_critical",
"managedby",
"deduplication",
"aclmode",
"acltype",
"xattr",
"atime",
"casesensitivity",
"checksum",
"exec",
"sync",
"compression",
"compressratio",
"origin",
"quota",
"refquota",
"reservation",
"refreservation",
"copies",
"snapdir",
"readonly",
"recordsize",
"sparse",
"volsize",
"volblocksize",
"key_format",
"encryption_algorithm",
"used",
"usedbychildren",
"usedbydataset",
"usedbyrefreservation",
"usedbysnapshots",
"available",
"special_small_block_size",
"pbkdf2iters",
"creation",
"snapdev",
"mountpoint"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
pool.dataset.get_quota |
---|
Arguments:
{
"_name_": "ds",
"title": "ds",
"_required_": true,
"type": "string",
"description": "Return a list of the specified `quota_type` of quotas on the ZFS dataset `ds`.\nSupport `query-filters` and `query-options`. used_bytes may not instantly\nupdate as space is used."
}
{
"_name_": "quota_type",
"title": "quota_type",
"_required_": false,
"type": "string",
"enum": [
"USER",
"GROUP",
"DATASET",
"PROJECT"
],
"description": "Return a list of the specified `quota_type` of quotas on the ZFS dataset `ds`.\nSupport `query-filters` and `query-options`. used_bytes may not instantly\nupdate as space is used."
}
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return a list of the specified When quota_type is not DATASET, each quota entry has these fields:
Note: SMB client requests to set a quota granting no space will result in an on-disk quota of 1 KiB. |
pool.dataset.inherit_parent_encryption_properties |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
|
Allows inheriting parent's encryption root discarding its current encryption settings. This
can only be done where |
pool.dataset.lock
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Locks `id` dataset. It will unmount the dataset and its children before locking."
}
{
"type": "object",
"properties": {
"force_umount": {
"type": "boolean",
"_name_": "force_umount",
"title": "force_umount",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "lock_options",
"title": "lock_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"force_umount"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
|
Locks After the dataset has been unmounted, system will set immutable flag on the dataset's mountpoint where the dataset was mounted before it was locked making sure that the path cannot be modified. Once the dataset is unlocked, it will not be affected by this change and consumers can continue consuming it. |
pool.dataset.mountpoint |
---|
Arguments:
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
{
"type": "boolean",
"_name_": "raise",
"title": "raise",
"default": true,
"_required_": false
}
|
Return Arguments:
{
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns mountpoint for specific mounted dataset. If it is not mounted and |
pool.dataset.processes |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
}
|
Return Arguments:
{
"_name_": "processes",
"title": "processes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"pid": {
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
},
"cmdline": {
"_name_": "cmdline",
"title": "cmdline",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "process",
"title": "process",
"default": {},
"_required_": false,
"_attrs_order_": [
"pid",
"name",
"service",
"cmdline"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Return a list of processes using this dataset. Example return value: [ { "pid": 2520, "name": "smbd", "service": "cifs" }, { "pid": 97778, "name": "minio", "cmdline": "/usr/local/bin/minio -C /usr/local/etc/minio server --address=0.0.0.0:9000 --quiet /mnt/tank/wk" } ] |
pool.dataset.promote |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
|
Promote the cloned dataset |
pool.dataset.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"encrypted": {
"type": "boolean",
"_name_": "encrypted",
"title": "encrypted",
"_required_": false
},
"encryption_root": {
"_name_": "encryption_root",
"title": "encryption_root",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_loaded": {
"type": [
"boolean",
"null"
],
"_name_": "key_loaded",
"title": "key_loaded",
"_required_": false
},
"children": {
"_name_": "children",
"title": "children",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"user_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "user_properties",
"title": "user_properties",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"comments": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "comments",
"title": "comments",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_warning",
"title": "quota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_critical",
"title": "quota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_warning",
"title": "refquota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_critical",
"title": "refquota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"managedby": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "managedby",
"title": "managedby",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"deduplication": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "deduplication",
"title": "deduplication",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"aclmode": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "aclmode",
"title": "aclmode",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"acltype": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltype",
"title": "acltype",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"xattr": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "xattr",
"title": "xattr",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"atime": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "atime",
"title": "atime",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"casesensitivity": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "casesensitivity",
"title": "casesensitivity",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"checksum": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "checksum",
"title": "checksum",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"exec": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exec",
"title": "exec",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sync": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sync",
"title": "sync",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compression": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compression",
"title": "compression",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compressratio": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compressratio",
"title": "compressratio",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"origin": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "origin",
"title": "origin",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota",
"title": "quota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota",
"title": "refquota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"reservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reservation",
"title": "reservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refreservation",
"title": "refreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"copies": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "copies",
"title": "copies",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdir": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdir",
"title": "snapdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"readonly": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "readonly",
"title": "readonly",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"recordsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "recordsize",
"title": "recordsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sparse": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sparse",
"title": "sparse",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volsize",
"title": "volsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volblocksize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volblocksize",
"title": "volblocksize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"key_format": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "key_format",
"title": "key_format",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"encryption_algorithm": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm",
"title": "encryption_algorithm",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"used": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "used",
"title": "used",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbychildren": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbychildren",
"title": "usedbychildren",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbydataset": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbydataset",
"title": "usedbydataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbyrefreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbyrefreservation",
"title": "usedbyrefreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbysnapshots": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbysnapshots",
"title": "usedbysnapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"available": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "available",
"title": "available",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"special_small_block_size": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"pbkdf2iters": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"creation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "creation",
"title": "creation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdev": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdev",
"title": "snapdev",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_entry",
"title": "pool_dataset_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"pool",
"encrypted",
"encryption_root",
"key_loaded",
"children",
"user_properties",
"locked",
"comments",
"quota_warning",
"quota_critical",
"refquota_warning",
"refquota_critical",
"managedby",
"deduplication",
"aclmode",
"acltype",
"xattr",
"atime",
"casesensitivity",
"checksum",
"exec",
"sync",
"compression",
"compressratio",
"origin",
"quota",
"refquota",
"reservation",
"refreservation",
"copies",
"snapdir",
"readonly",
"recordsize",
"sparse",
"volsize",
"volblocksize",
"key_format",
"encryption_algorithm",
"used",
"usedbychildren",
"usedbydataset",
"usedbyrefreservation",
"usedbysnapshots",
"available",
"special_small_block_size",
"pbkdf2iters",
"creation",
"snapdev",
"mountpoint"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"encrypted": {
"type": "boolean",
"_name_": "encrypted",
"title": "encrypted",
"_required_": false
},
"encryption_root": {
"_name_": "encryption_root",
"title": "encryption_root",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_loaded": {
"type": [
"boolean",
"null"
],
"_name_": "key_loaded",
"title": "key_loaded",
"_required_": false
},
"children": {
"_name_": "children",
"title": "children",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"user_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "user_properties",
"title": "user_properties",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"comments": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "comments",
"title": "comments",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_warning",
"title": "quota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_critical",
"title": "quota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_warning",
"title": "refquota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_critical",
"title": "refquota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"managedby": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "managedby",
"title": "managedby",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"deduplication": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "deduplication",
"title": "deduplication",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"aclmode": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "aclmode",
"title": "aclmode",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"acltype": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltype",
"title": "acltype",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"xattr": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "xattr",
"title": "xattr",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"atime": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "atime",
"title": "atime",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"casesensitivity": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "casesensitivity",
"title": "casesensitivity",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"checksum": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "checksum",
"title": "checksum",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"exec": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exec",
"title": "exec",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sync": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sync",
"title": "sync",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compression": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compression",
"title": "compression",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compressratio": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compressratio",
"title": "compressratio",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"origin": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "origin",
"title": "origin",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota",
"title": "quota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota",
"title": "refquota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"reservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reservation",
"title": "reservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refreservation",
"title": "refreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"copies": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "copies",
"title": "copies",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdir": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdir",
"title": "snapdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"readonly": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "readonly",
"title": "readonly",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"recordsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "recordsize",
"title": "recordsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sparse": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sparse",
"title": "sparse",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volsize",
"title": "volsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volblocksize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volblocksize",
"title": "volblocksize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"key_format": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "key_format",
"title": "key_format",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"encryption_algorithm": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm",
"title": "encryption_algorithm",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"used": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "used",
"title": "used",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbychildren": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbychildren",
"title": "usedbychildren",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbydataset": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbydataset",
"title": "usedbydataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbyrefreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbyrefreservation",
"title": "usedbyrefreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbysnapshots": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbysnapshots",
"title": "usedbysnapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"available": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "available",
"title": "available",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"special_small_block_size": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"pbkdf2iters": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"creation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "creation",
"title": "creation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdev": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdev",
"title": "snapdev",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_entry",
"title": "pool_dataset_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"pool",
"encrypted",
"encryption_root",
"key_loaded",
"children",
"user_properties",
"locked",
"comments",
"quota_warning",
"quota_critical",
"refquota_warning",
"refquota_critical",
"managedby",
"deduplication",
"aclmode",
"acltype",
"xattr",
"atime",
"casesensitivity",
"checksum",
"exec",
"sync",
"compression",
"compressratio",
"origin",
"quota",
"refquota",
"reservation",
"refreservation",
"copies",
"snapdir",
"readonly",
"recordsize",
"sparse",
"volsize",
"volblocksize",
"key_format",
"encryption_algorithm",
"used",
"usedbychildren",
"usedbydataset",
"usedbyrefreservation",
"usedbysnapshots",
"available",
"special_small_block_size",
"pbkdf2iters",
"creation",
"snapdev",
"mountpoint"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"encrypted": {
"type": "boolean",
"_name_": "encrypted",
"title": "encrypted",
"_required_": false
},
"encryption_root": {
"_name_": "encryption_root",
"title": "encryption_root",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_loaded": {
"type": [
"boolean",
"null"
],
"_name_": "key_loaded",
"title": "key_loaded",
"_required_": false
},
"children": {
"_name_": "children",
"title": "children",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"user_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "user_properties",
"title": "user_properties",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"comments": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "comments",
"title": "comments",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_warning",
"title": "quota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_critical",
"title": "quota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_warning",
"title": "refquota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_critical",
"title": "refquota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"managedby": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "managedby",
"title": "managedby",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"deduplication": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "deduplication",
"title": "deduplication",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"aclmode": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "aclmode",
"title": "aclmode",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"acltype": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltype",
"title": "acltype",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"xattr": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "xattr",
"title": "xattr",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"atime": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "atime",
"title": "atime",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"casesensitivity": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "casesensitivity",
"title": "casesensitivity",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"checksum": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "checksum",
"title": "checksum",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"exec": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exec",
"title": "exec",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sync": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sync",
"title": "sync",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compression": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compression",
"title": "compression",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compressratio": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compressratio",
"title": "compressratio",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"origin": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "origin",
"title": "origin",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota",
"title": "quota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota",
"title": "refquota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"reservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reservation",
"title": "reservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refreservation",
"title": "refreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"copies": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "copies",
"title": "copies",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdir": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdir",
"title": "snapdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"readonly": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "readonly",
"title": "readonly",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"recordsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "recordsize",
"title": "recordsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sparse": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sparse",
"title": "sparse",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volsize",
"title": "volsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volblocksize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volblocksize",
"title": "volblocksize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"key_format": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "key_format",
"title": "key_format",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"encryption_algorithm": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm",
"title": "encryption_algorithm",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"used": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "used",
"title": "used",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbychildren": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbychildren",
"title": "usedbychildren",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbydataset": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbydataset",
"title": "usedbydataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbyrefreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbyrefreservation",
"title": "usedbyrefreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbysnapshots": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbysnapshots",
"title": "usedbysnapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"available": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "available",
"title": "available",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"special_small_block_size": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"pbkdf2iters": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"creation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "creation",
"title": "creation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdev": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdev",
"title": "snapdev",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_entry",
"title": "pool_dataset_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"pool",
"encrypted",
"encryption_root",
"key_loaded",
"children",
"user_properties",
"locked",
"comments",
"quota_warning",
"quota_critical",
"refquota_warning",
"refquota_critical",
"managedby",
"deduplication",
"aclmode",
"acltype",
"xattr",
"atime",
"casesensitivity",
"checksum",
"exec",
"sync",
"compression",
"compressratio",
"origin",
"quota",
"refquota",
"reservation",
"refreservation",
"copies",
"snapdir",
"readonly",
"recordsize",
"sparse",
"volsize",
"volblocksize",
"key_format",
"encryption_algorithm",
"used",
"usedbychildren",
"usedbydataset",
"usedbyrefreservation",
"usedbysnapshots",
"available",
"special_small_block_size",
"pbkdf2iters",
"creation",
"snapdev",
"mountpoint"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query Pool Datasets with We provide two ways to retrieve datasets. The first is a flat structure (default), where
all datasets in the system are returned as separate objects which contain all data
there is for their children. This retrieval type is slightly slower because of duplicates in each object.
The second type is hierarchical, where only top level datasets are returned in the list. They contain all the
children in the In some cases it might be desirable to only retrieve details of a dataset itself and not it's children, in this
case In case only some properties are desired to be retrieved for datasets, consumer should specify
|
pool.dataset.recommended_zvol_blocksize |
---|
Arguments:
{
"_name_": "pool",
"title": "pool",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "recommended_zvol_blocksize",
"title": "recommended_zvol_blocksize",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Helper method to get recommended size for a new zvol (dataset of type VOLUME). |
Get blocksize for pool "tank".
|
pool.dataset.recordsize_choices |
---|
Arguments:
{
"_name_": "pool_name",
"title": "pool_name",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
|
Return Arguments:
{
"_name_": "recordsize_choices",
"title": "recordsize_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "recordsize_value",
"title": "recordsize_value",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Retrieve recordsize choices for datasets. |
pool.dataset.set_quota |
---|
Arguments:
{
"_name_": "ds",
"title": "ds",
"_required_": true,
"type": "string",
"description": "`ds` the name of the target ZFS dataset."
}
{
"_name_": "quotas",
"title": "quotas",
"default": [
{
"quota_type": "USER",
"id": "0",
"quota_value": 0
}
],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"quota_type": {
"_name_": "quota_type",
"title": "quota_type",
"_required_": true,
"type": "string",
"enum": [
"DATASET",
"USER",
"USEROBJ",
"GROUP",
"GROUPOBJ"
]
},
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"quota_value": {
"type": [
"integer",
"null"
],
"_name_": "quota_value",
"title": "quota_value",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "quota_entry",
"title": "quota_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"quota_type",
"id",
"quota_value"
]
}
],
"description": "`quotas` specifies a list of `quota_entry` entries to apply to dataset."
}
|
This method is accessible to the users granted with the following roles: DATASET_WRITE, SHARING_ADMIN |
There are three over-arching types of quotas for ZFS datasets.
1) dataset quotas and refquotas. If a DATASET quota type is specified in
this API call, then the API acts as a wrapper for 2) User and group quotas. These limit the amount of disk space consumed by files that are owned by the specified users or groups. If the respective "object quota" type is specfied, then the quota limits the number of objects that may be owned by the specified user or group. 3) Project quotas. These limit the amount of disk space consumed by files that are owned by the specified project. Project quotas are not yet implemended. This API allows users to set multiple quotas simultaneously by submitting a list of quotas. The list may contain all supported quota types.
|
pool.dataset.snapshot_count |
---|
Arguments:
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "integer",
"_name_": "snapshot_count",
"title": "snapshot_count",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns snapshot count for specified |
pool.dataset.unlock |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Unlock dataset `id` (and its children if `unlock_options.recursive` is `true`).\nIf `id` dataset is not encrypted an exception will be raised. There is one exception:\nwhen `id` is a root dataset and `unlock_options.recursive` is specified, encryption\nvalidation will not be performed for `id`. This allow unlocking encrypted children for the entire pool `id`."
}
{
"type": "object",
"properties": {
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
},
"key_file": {
"type": "boolean",
"_name_": "key_file",
"title": "key_file",
"default": false,
"_required_": false
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
},
"toggle_attachments": {
"type": "boolean",
"_name_": "toggle_attachments",
"title": "toggle_attachments",
"default": true,
"_required_": false
},
"datasets": {
"_name_": "datasets",
"title": "datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"key": {
"_name_": "key",
"title": "key",
"_required_": false,
"type": "string"
},
"passphrase": {
"_name_": "passphrase",
"title": "passphrase",
"_required_": false,
"type": "string"
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "dataset",
"title": "dataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"force",
"name",
"key",
"passphrase",
"recursive"
]
}
]
}
},
"additionalProperties": false,
"_name_": "unlock_options",
"title": "unlock_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"force",
"key_file",
"recursive",
"toggle_attachments",
"datasets"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"unlocked": {
"_name_": "unlocked",
"title": "unlocked",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
]
},
"failed": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "failed",
"title": "failed",
"description": "\n\nExample(s):\n```\n{\n \"vol1/enc\": {\n \"error\": \"Invalid Key\",\n \"skipped\": []\n }\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "unlock",
"title": "unlock",
"default": {},
"_required_": false,
"_attrs_order_": [
"unlocked",
"failed"
]
}
|
Unlock dataset If There are two ways to supply the key(s)/passphrase(s) for unlocking a dataset:
If
In some cases it's possible that the provided key/passphrase is valid but the path where the dataset is
supposed to be mounted after being unlocked already exists and is not empty. In this case, unlock operation
would fail. This can be overridden by setting |
pool.dataset.unlock_services_restart_choices |
---|
Arguments:
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "services_to_restart",
"title": "services_to_restart",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: DATASET_READ, DATASET_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Get a mapping of services identifiers and labels that can be restart on dataset unlock. |
pool.dataset.update |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string",
"description": "Updates a dataset/zvol `id`."
}
{
"type": "object",
"properties": {
"volsize": {
"type": "integer",
"_name_": "volsize",
"title": "volsize",
"_required_": false,
"description": "`volsize` is required for type=VOLUME and is supposed to be a multiple of the block size.\n`sparse` and `volblocksize` are only used for type=VOLUME."
},
"force_size": {
"type": "boolean",
"_name_": "force_size",
"title": "force_size",
"_required_": false
},
"comments": {
"_name_": "comments",
"title": "comments",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"sync": {
"_name_": "sync",
"title": "sync",
"_required_": false,
"enum": [
"STANDARD",
"ALWAYS",
"DISABLED"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"snapdev": {
"_name_": "snapdev",
"title": "snapdev",
"_required_": false,
"enum": [
"HIDDEN",
"VISIBLE"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"compression": {
"_name_": "compression",
"title": "compression",
"_required_": false,
"enum": [
"ON",
"OFF",
"LZ4",
"GZIP",
"GZIP-1",
"GZIP-9",
"ZSTD",
"ZSTD-FAST",
"ZLE",
"LZJB",
"ZSTD-1",
"ZSTD-2",
"ZSTD-3",
"ZSTD-4",
"ZSTD-5",
"ZSTD-6",
"ZSTD-7",
"ZSTD-8",
"ZSTD-9",
"ZSTD-10",
"ZSTD-11",
"ZSTD-12",
"ZSTD-13",
"ZSTD-14",
"ZSTD-15",
"ZSTD-16",
"ZSTD-17",
"ZSTD-18",
"ZSTD-19",
"ZSTD-FAST-1",
"ZSTD-FAST-2",
"ZSTD-FAST-3",
"ZSTD-FAST-4",
"ZSTD-FAST-5",
"ZSTD-FAST-6",
"ZSTD-FAST-7",
"ZSTD-FAST-8",
"ZSTD-FAST-9",
"ZSTD-FAST-10",
"ZSTD-FAST-20",
"ZSTD-FAST-30",
"ZSTD-FAST-40",
"ZSTD-FAST-50",
"ZSTD-FAST-60",
"ZSTD-FAST-70",
"ZSTD-FAST-80",
"ZSTD-FAST-90",
"ZSTD-FAST-100",
"ZSTD-FAST-500",
"ZSTD-FAST-1000"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"atime": {
"_name_": "atime",
"title": "atime",
"_required_": false,
"enum": [
"ON",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"exec": {
"_name_": "exec",
"title": "exec",
"_required_": false,
"enum": [
"ON",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"managedby": {
"_name_": "managedby",
"title": "managedby",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"quota": {
"type": [
"integer",
"null"
],
"_name_": "quota",
"title": "quota",
"_required_": false
},
"quota_warning": {
"_name_": "quota_warning",
"title": "quota_warning",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"quota_critical": {
"_name_": "quota_critical",
"title": "quota_critical",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"refquota": {
"type": [
"integer",
"null"
],
"_name_": "refquota",
"title": "refquota",
"_required_": false
},
"refquota_warning": {
"_name_": "refquota_warning",
"title": "refquota_warning",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"refquota_critical": {
"_name_": "refquota_critical",
"title": "refquota_critical",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"reservation": {
"type": "integer",
"_name_": "reservation",
"title": "reservation",
"_required_": false
},
"refreservation": {
"type": "integer",
"_name_": "refreservation",
"title": "refreservation",
"_required_": false
},
"special_small_block_size": {
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"copies": {
"_name_": "copies",
"title": "copies",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "integer"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"snapdir": {
"_name_": "snapdir",
"title": "snapdir",
"_required_": false,
"enum": [
"VISIBLE",
"HIDDEN"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"deduplication": {
"_name_": "deduplication",
"title": "deduplication",
"_required_": false,
"enum": [
"ON",
"VERIFY",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"checksum": {
"_name_": "checksum",
"title": "checksum",
"_required_": false,
"enum": [
"ON",
"OFF",
"FLETCHER2",
"FLETCHER4",
"SHA256",
"SHA512",
"SKEIN",
"EDONR",
"BLAKE3"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"readonly": {
"_name_": "readonly",
"title": "readonly",
"_required_": false,
"enum": [
"ON",
"OFF"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"recordsize": {
"_name_": "recordsize",
"title": "recordsize",
"_required_": false,
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"aclmode": {
"_name_": "aclmode",
"title": "aclmode",
"_required_": false,
"enum": [
"PASSTHROUGH",
"RESTRICTED",
"DISCARD"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": false,
"enum": [
"OFF",
"NFSV4",
"POSIX"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"xattr": {
"_name_": "xattr",
"title": "xattr",
"default": "SA",
"_required_": false,
"enum": [
"ON",
"SA"
],
"nullable": false,
"anyOf": [
{
"type": "string"
},
{
"type": "string",
"enum": [
"INHERIT"
]
}
]
},
"user_properties": {
"_name_": "user_properties",
"title": "user_properties",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"key": {
"_name_": "key",
"title": "key",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "user_property",
"title": "user_property",
"default": {},
"_required_": false,
"_attrs_order_": [
"key",
"value"
]
}
]
},
"create_ancestors": {
"type": "boolean",
"_name_": "create_ancestors",
"title": "create_ancestors",
"default": false,
"_required_": false
},
"user_properties_update": {
"_name_": "user_properties_update",
"title": "user_properties_update",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"key": {
"_name_": "key",
"title": "key",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": "string"
},
"remove": {
"type": "boolean",
"_name_": "remove",
"title": "remove",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "user_property",
"title": "user_property",
"default": {},
"_required_": false,
"_attrs_order_": [
"key",
"value",
"remove"
]
}
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_update",
"title": "pool_dataset_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"volsize",
"force_size",
"comments",
"sync",
"snapdev",
"compression",
"atime",
"exec",
"managedby",
"quota",
"quota_warning",
"quota_critical",
"refquota",
"refquota_warning",
"refquota_critical",
"reservation",
"refreservation",
"special_small_block_size",
"copies",
"snapdir",
"deduplication",
"checksum",
"readonly",
"recordsize",
"aclmode",
"acltype",
"xattr",
"user_properties",
"create_ancestors",
"user_properties_update"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string",
"description": "Updates a dataset/zvol `id`."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`encryption` when enabled will create an ZFS encrypted root dataset for `name` pool.\nThere is 1 case where ZFS encryption is not allowed for a dataset:\n1) If the parent dataset is encrypted with a passphrase and `name` is being created\n with a key for encrypting the dataset.\n`encryption_options` specifies configuration for encryption of dataset for `name` pool.\n`encryption_options.passphrase` must be specified if encryption for dataset is desired with a passphrase\nas a key.\nOtherwise a hex encoded key can be specified by providing `encryption_options.key`.\n`encryption_options.generate_key` when enabled automatically generates the key to be used\nfor dataset encryption."
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"encrypted": {
"type": "boolean",
"_name_": "encrypted",
"title": "encrypted",
"_required_": false
},
"encryption_root": {
"_name_": "encryption_root",
"title": "encryption_root",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_loaded": {
"type": [
"boolean",
"null"
],
"_name_": "key_loaded",
"title": "key_loaded",
"_required_": false
},
"children": {
"_name_": "children",
"title": "children",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"user_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "user_properties",
"title": "user_properties",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"comments": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "comments",
"title": "comments",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_warning",
"title": "quota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_critical",
"title": "quota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_warning",
"title": "refquota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_critical",
"title": "refquota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"managedby": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "managedby",
"title": "managedby",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"deduplication": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "deduplication",
"title": "deduplication",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"aclmode": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "aclmode",
"title": "aclmode",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"acltype": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltype",
"title": "acltype",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"xattr": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "xattr",
"title": "xattr",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"atime": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "atime",
"title": "atime",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"casesensitivity": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "casesensitivity",
"title": "casesensitivity",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"checksum": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "checksum",
"title": "checksum",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"exec": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exec",
"title": "exec",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sync": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sync",
"title": "sync",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compression": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compression",
"title": "compression",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compressratio": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compressratio",
"title": "compressratio",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"origin": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "origin",
"title": "origin",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota",
"title": "quota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota",
"title": "refquota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"reservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reservation",
"title": "reservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refreservation",
"title": "refreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"copies": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "copies",
"title": "copies",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdir": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdir",
"title": "snapdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"readonly": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "readonly",
"title": "readonly",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"recordsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "recordsize",
"title": "recordsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sparse": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sparse",
"title": "sparse",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
],
"description": "`sparse` and `volblocksize` are only used for type=VOLUME."
},
"volsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volsize",
"title": "volsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
],
"description": "`volsize` is required for type=VOLUME and is supposed to be a multiple of the block size."
},
"volblocksize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volblocksize",
"title": "volblocksize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
],
"description": "`sparse` and `volblocksize` are only used for type=VOLUME."
},
"key_format": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "key_format",
"title": "key_format",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"encryption_algorithm": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm",
"title": "encryption_algorithm",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"used": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "used",
"title": "used",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbychildren": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbychildren",
"title": "usedbychildren",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbydataset": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbydataset",
"title": "usedbydataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbyrefreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbyrefreservation",
"title": "usedbyrefreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbysnapshots": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbysnapshots",
"title": "usedbysnapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"available": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "available",
"title": "available",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"special_small_block_size": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"pbkdf2iters": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"creation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "creation",
"title": "creation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdev": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdev",
"title": "snapdev",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_update_returns",
"title": "pool_dataset_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"pool",
"encrypted",
"encryption_root",
"key_loaded",
"children",
"user_properties",
"locked",
"comments",
"quota_warning",
"quota_critical",
"refquota_warning",
"refquota_critical",
"managedby",
"deduplication",
"aclmode",
"acltype",
"xattr",
"atime",
"casesensitivity",
"checksum",
"exec",
"sync",
"compression",
"compressratio",
"origin",
"quota",
"refquota",
"reservation",
"refreservation",
"copies",
"snapdir",
"readonly",
"recordsize",
"sparse",
"volsize",
"volblocksize",
"key_format",
"encryption_algorithm",
"used",
"usedbychildren",
"usedbydataset",
"usedbyrefreservation",
"usedbysnapshots",
"available",
"special_small_block_size",
"pbkdf2iters",
"creation",
"snapdev",
"mountpoint"
]
}
|
This method is accessible to the users granted with the following roles: DATASET_WRITE, SHARING_ADMIN |
Updates a dataset/zvol |
Update the
|
pool.dataset.userprop.create |
---|
Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"property": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "property",
"title": "property",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"value"
]
}
},
"additionalProperties": false,
"_name_": "dataset_user_prop_create",
"title": "dataset_user_prop_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"property"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "pool_dataset_userprop_create_returns",
"title": "pool_dataset_userprop_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"properties"
]
}
|
Create a user property for a given |
pool.dataset.userprop.delete |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "dataset_user_prop_delete",
"title": "dataset_user_prop_delete",
"default": {},
"_required_": false,
"_attrs_order_": [
"name"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete user property |
pool.dataset.userprop.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string",
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "pool_dataset_userprop_entry",
"title": "pool_dataset_userprop_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"properties"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
pool.dataset.userprop.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "pool_dataset_userprop_entry",
"title": "pool_dataset_userprop_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"properties"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "pool_dataset_userprop_entry",
"title": "pool_dataset_userprop_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"properties"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "pool_dataset_userprop_entry",
"title": "pool_dataset_userprop_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"properties"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Query all user properties for ZFS datasets. |
pool.dataset.userprop.update |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "dataset_user_prop_update",
"title": "dataset_user_prop_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"value"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "pool_dataset_userprop_update_returns",
"title": "pool_dataset_userprop_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"properties"
]
}
|
Update |
pool.resilver.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"begin": {
"_name_": "begin",
"title": "begin",
"_required_": true,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"_required_": true,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"weekday": {
"_name_": "weekday",
"title": "weekday",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "weekday",
"title": "weekday",
"_required_": false
}
]
}
},
"additionalProperties": false,
"_name_": "pool_resilver_entry",
"title": "pool_resilver_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"begin",
"end",
"enabled",
"weekday"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
pool.resilver.update |
---|
Arguments:
{
"type": "object",
"properties": {
"begin": {
"_name_": "begin",
"title": "begin",
"_required_": true,
"type": "string",
"description": "If `begin` time is greater than `end` time it means it will rollover the day, e.g.\nbegin = \"19:00\", end = \"05:00\" will increase pool resilver priority from 19:00 of one day\nuntil 05:00 of the next day."
},
"end": {
"_name_": "end",
"title": "end",
"_required_": true,
"type": "string",
"description": "If `begin` time is greater than `end` time it means it will rollover the day, e.g.\nbegin = \"19:00\", end = \"05:00\" will increase pool resilver priority from 19:00 of one day\nuntil 05:00 of the next day."
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"weekday": {
"_name_": "weekday",
"title": "weekday",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "weekday",
"title": "weekday",
"_required_": false
}
],
"description": "`weekday` follows crontab(5) values 0-7 (0 or 7 is Sun)."
}
},
"additionalProperties": false,
"_name_": "pool_resilver_update",
"title": "pool_resilver_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"begin",
"end",
"enabled",
"weekday"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"begin": {
"_name_": "begin",
"title": "begin",
"_required_": true,
"type": "string",
"description": "If `begin` time is greater than `end` time it means it will rollover the day, e.g.\nbegin = \"19:00\", end = \"05:00\" will increase pool resilver priority from 19:00 of one day\nuntil 05:00 of the next day."
},
"end": {
"_name_": "end",
"title": "end",
"_required_": true,
"type": "string",
"description": "If `begin` time is greater than `end` time it means it will rollover the day, e.g.\nbegin = \"19:00\", end = \"05:00\" will increase pool resilver priority from 19:00 of one day\nuntil 05:00 of the next day."
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"weekday": {
"_name_": "weekday",
"title": "weekday",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "weekday",
"title": "weekday",
"_required_": false
}
],
"description": "`weekday` follows crontab(5) values 0-7 (0 or 7 is Sun)."
}
},
"additionalProperties": false,
"_name_": "pool_resilver_update_returns",
"title": "pool_resilver_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"begin",
"end",
"enabled",
"weekday"
]
}
|
Configure Pool Resilver Priority. If
|
Enable pool resilver priority all business days from 7PM to 5AM.
|
pool.scrub.create |
---|
Arguments:
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": false,
"description": "`threshold` refers to the minimum amount of time in days has to be passed before\na scrub can run again."
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
}
},
"additionalProperties": false,
"_name_": "pool_scrub_entry",
"title": "pool_scrub_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true,
"description": "`threshold` refers to the minimum amount of time in days has to be passed before\na scrub can run again."
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_create_returns",
"title": "pool_scrub_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"id",
"pool_name"
]
}
|
This method is accessible to the users granted with the following roles: POOL_SCRUB_WRITE |
Create a scrub task for a pool.
|
Create a scrub task for pool of id 1, to run every sunday but with a threshold of 35 days. The check will run at 3AM every sunday.
|
pool.scrub.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: POOL_SCRUB_WRITE |
Delete scrub task of |
pool.scrub.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_entry",
"title": "pool_scrub_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"id",
"pool_name"
]
}
|
This method is accessible to the users granted with the following roles: POOL_SCRUB_READ, POOL_SCRUB_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
pool.scrub.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_entry",
"title": "pool_scrub_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"id",
"pool_name"
]
}
]
},
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_entry",
"title": "pool_scrub_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"id",
"pool_name"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_entry",
"title": "pool_scrub_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"id",
"pool_name"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: POOL_SCRUB_READ, POOL_SCRUB_WRITE, READONLY_ADMIN, SHARING_ADMIN |
- |
pool.scrub.run |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
{
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"default": 35,
"_required_": false
}
|
Initiate a scrub of a pool |
pool.scrub.scrub
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
}
{
"_name_": "action",
"title": "action",
"default": "START",
"_required_": false,
"type": "string",
"enum": [
"START",
"STOP",
"PAUSE"
]
}
|
Start/Stop/Pause a scrub on pool |
pool.scrub.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update scrub task of `id`.\nCreate a scrub task for a pool."
}
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true,
"description": "`threshold` refers to the minimum amount of time in days has to be passed before\na scrub can run again."
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_update",
"title": "pool_scrub_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"pool_name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true,
"description": "`threshold` refers to the minimum amount of time in days has to be passed before\na scrub can run again."
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update scrub task of `id`.\nCreate a scrub task for a pool."
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_update_returns",
"title": "pool_scrub_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"id",
"pool_name"
]
}
|
This method is accessible to the users granted with the following roles: POOL_SCRUB_WRITE |
Update scrub task of |
pool.snapshottask.create |
---|
Arguments:
{
"type": "object",
"properties": {
"dataset": {
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string",
"description": "Create a Periodic Snapshot Task that will take snapshots of specified `dataset` at specified `schedule`."
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": true,
"description": "Recursive snapshots can be created if `recursive` flag is enabled. You can `exclude` specific child datasets\nor zvols from the snapshot.\nSnapshots will be automatically destroyed after a certain amount of time, specified by"
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "item",
"title": "item",
"_required_": false,
"type": "string"
}
],
"description": "Recursive snapshots can be created if `recursive` flag is enabled. You can `exclude` specific child datasets\nor zvols from the snapshot.\nSnapshots will be automatically destroyed after a certain amount of time, specified by"
},
"lifetime_value": {
"type": "integer",
"_name_": "lifetime_value",
"title": "lifetime_value",
"_required_": true,
"description": "`lifetime_value` and `lifetime_unit`.\nIf multiple periodic tasks create snapshots at the same time (for example hourly and daily at 00:00) the snapshot\nwill be kept until the last of these tasks reaches its expiry time."
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"_required_": true,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
],
"description": "`lifetime_value` and `lifetime_unit`.\nIf multiple periodic tasks create snapshots at the same time (for example hourly and daily at 00:00) the snapshot\nwill be kept until the last of these tasks reaches its expiry time."
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": true,
"type": "string",
"description": "Snapshots will be named according to `naming_schema` which is a `strftime`-like template for snapshot name\nand must contain `%Y`, `%m`, `%d`, `%H` and `%M`."
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
],
"description": "Create a Periodic Snapshot Task that will take snapshots of specified `dataset` at specified `schedule`."
},
"allow_empty": {
"type": "boolean",
"_name_": "allow_empty",
"title": "allow_empty",
"default": true,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "periodic_snapshot_create",
"title": "periodic_snapshot_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"dataset",
"recursive",
"exclude",
"lifetime_value",
"lifetime_unit",
"naming_schema",
"schedule",
"allow_empty",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "pool_snapshottask_create_returns",
"title": "pool_snapshottask_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
Create a Periodic Snapshot Task Create a Periodic Snapshot Task that will take snapshots of specified |
Create a recursive Periodic Snapshot Task for dataset
|
pool.snapshottask.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete a Periodic Snapshot Task with specific `id`"
}
{
"type": "object",
"properties": {
"fixate_removal_date": {
"type": "boolean",
"_name_": "fixate_removal_date",
"title": "fixate_removal_date",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"fixate_removal_date"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete a Periodic Snapshot Task with specific |
|
pool.snapshottask.delete_will_change_retention_for |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "snapshots",
"title": "snapshots",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
Returns a list of snapshots which will change the retention if periodic snapshot task |
pool.snapshottask.foreseen_count |
---|
Arguments:
{
"type": "object",
"properties": {
"lifetime_value": {
"type": "integer",
"_name_": "lifetime_value",
"title": "lifetime_value",
"_required_": true
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"_required_": true,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
]
}
},
"additionalProperties": false,
"_name_": "periodic_snapshot_foreseen_count",
"title": "periodic_snapshot_foreseen_count",
"default": {},
"_required_": false,
"_attrs_order_": [
"lifetime_value",
"lifetime_unit",
"schedule"
]
}
|
Return Arguments:
{
"type": "integer",
"_name_": "foreseen_count",
"title": "foreseen_count",
"_required_": false
}
|
Returns a number of snapshots (per-dataset) being retained if a periodic snapshot task with specific parameters is created. |
pool.snapshottask.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "pool_snapshottask_entry",
"title": "pool_snapshottask_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
pool.snapshottask.max_count |
---|
Return Arguments:
{
"type": "integer",
"_name_": "max_count",
"title": "max_count",
"_required_": false
}
|
Returns a maximum amount of snapshots (per-dataset) the system can sustain. |
pool.snapshottask.max_total_count |
---|
Return Arguments:
{
"type": "integer",
"_name_": "max_total_count",
"title": "max_total_count",
"_required_": false
}
|
Returns a maximum amount of snapshots (total) the system can sustain. |
pool.snapshottask.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "pool_snapshottask_entry",
"title": "pool_snapshottask_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "pool_snapshottask_entry",
"title": "pool_snapshottask_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "pool_snapshottask_entry",
"title": "pool_snapshottask_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
pool.snapshottask.run |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Execute a Periodic Snapshot Task of |
pool.snapshottask.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update a Periodic Snapshot Task with specific `id`"
}
{
"type": "object",
"properties": {
"dataset": {
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string",
"description": "Create a Periodic Snapshot Task that will take snapshots of specified `dataset` at specified `schedule`."
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": true,
"description": "Recursive snapshots can be created if `recursive` flag is enabled. You can `exclude` specific child datasets\nor zvols from the snapshot.\nSnapshots will be automatically destroyed after a certain amount of time, specified by"
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "item",
"title": "item",
"_required_": false,
"type": "string"
}
],
"description": "Recursive snapshots can be created if `recursive` flag is enabled. You can `exclude` specific child datasets\nor zvols from the snapshot.\nSnapshots will be automatically destroyed after a certain amount of time, specified by"
},
"lifetime_value": {
"type": "integer",
"_name_": "lifetime_value",
"title": "lifetime_value",
"_required_": true,
"description": "`lifetime_value` and `lifetime_unit`.\nIf multiple periodic tasks create snapshots at the same time (for example hourly and daily at 00:00) the snapshot\nwill be kept until the last of these tasks reaches its expiry time."
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"_required_": true,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
],
"description": "`lifetime_value` and `lifetime_unit`.\nIf multiple periodic tasks create snapshots at the same time (for example hourly and daily at 00:00) the snapshot\nwill be kept until the last of these tasks reaches its expiry time."
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": true,
"type": "string",
"description": "Snapshots will be named according to `naming_schema` which is a `strftime`-like template for snapshot name\nand must contain `%Y`, `%m`, `%d`, `%H` and `%M`."
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
],
"description": "Create a Periodic Snapshot Task that will take snapshots of specified `dataset` at specified `schedule`."
},
"allow_empty": {
"type": "boolean",
"_name_": "allow_empty",
"title": "allow_empty",
"default": true,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"fixate_removal_date": {
"type": "boolean",
"_name_": "fixate_removal_date",
"title": "fixate_removal_date",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "periodic_snapshot_update",
"title": "periodic_snapshot_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"dataset",
"recursive",
"exclude",
"lifetime_value",
"lifetime_unit",
"naming_schema",
"schedule",
"allow_empty",
"enabled",
"fixate_removal_date"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "pool_snapshottask_update_returns",
"title": "pool_snapshottask_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
Update a Periodic Snapshot Task with specific See the documentation for |
|
pool.snapshottask.update_will_change_retention_for |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"dataset": {
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string"
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": true
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "item",
"title": "item",
"_required_": false,
"type": "string"
}
]
},
"lifetime_value": {
"type": "integer",
"_name_": "lifetime_value",
"title": "lifetime_value",
"_required_": true
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"_required_": true,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
]
},
"allow_empty": {
"type": "boolean",
"_name_": "allow_empty",
"title": "allow_empty",
"default": true,
"_required_": false
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "periodic_snapshot_update_will_change_retention",
"title": "periodic_snapshot_update_will_change_retention",
"default": {},
"_required_": false,
"_attrs_order_": [
"dataset",
"recursive",
"exclude",
"lifetime_value",
"lifetime_unit",
"naming_schema",
"schedule",
"allow_empty",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "snapshots",
"title": "snapshots",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
Returns a list of snapshots which will change the retention if periodic snapshot task |
privilege.create |
---|
Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` is a name for privilege (must be unique)."
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
],
"description": "`allowlist` is a list of API endpoints allowed for this privilege."
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "local_group",
"title": "local_group",
"_required_": false
}
],
"description": "`local_groups` is a list of local user account group GIDs that gain this privilege."
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "ds_group_gid",
"title": "ds_group_gid",
"_required_": false
},
{
"_name_": "ds_group_sid",
"title": "ds_group_sid",
"_required_": false,
"type": "string"
}
],
"description": "`ds_groups` is list of Directory Service group GIDs that will gain this privilege."
}
},
"additionalProperties": false,
"_name_": "privilege_create",
"title": "privilege_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"allowlist",
"roles",
"web_shell",
"local_groups",
"ds_groups"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin_name": {
"_name_": "builtin_name",
"title": "builtin_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` is a name for privilege (must be unique)."
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
],
"description": "`local_groups` is a list of local user account group GIDs that gain this privilege."
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
],
"description": "`ds_groups` is list of Directory Service group GIDs that will gain this privilege."
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
],
"description": "`allowlist` is a list of API endpoints allowed for this privilege."
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "privilege_create_returns",
"title": "privilege_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"builtin_name",
"name",
"local_groups",
"ds_groups",
"allowlist",
"roles",
"web_shell"
]
}
|
Creates a privilege.
|
privilege.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete the privilege |
privilege.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"builtin_name": {
"_name_": "builtin_name",
"title": "builtin_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "privilege_entry",
"title": "privilege_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"builtin_name",
"name",
"local_groups",
"ds_groups",
"allowlist",
"roles",
"web_shell"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
privilege.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin_name": {
"_name_": "builtin_name",
"title": "builtin_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "privilege_entry",
"title": "privilege_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"builtin_name",
"name",
"local_groups",
"ds_groups",
"allowlist",
"roles",
"web_shell"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin_name": {
"_name_": "builtin_name",
"title": "builtin_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "privilege_entry",
"title": "privilege_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"builtin_name",
"name",
"local_groups",
"ds_groups",
"allowlist",
"roles",
"web_shell"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin_name": {
"_name_": "builtin_name",
"title": "builtin_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "privilege_entry",
"title": "privilege_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"builtin_name",
"name",
"local_groups",
"ds_groups",
"allowlist",
"roles",
"web_shell"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
privilege.roles |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"includes": {
"_name_": "includes",
"title": "includes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
]
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "role",
"title": "role",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"title",
"includes",
"builtin"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"includes": {
"_name_": "includes",
"title": "includes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
}
]
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "role",
"title": "role",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"title",
"includes",
"builtin"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
Get all available roles. Each entry contains the following keys:
|
privilege.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update the privilege `id`.\nCreates a privilege."
}
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update the privilege `id`.\nCreates a privilege."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` is a name for privilege (must be unique)."
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
],
"description": "`allowlist` is a list of API endpoints allowed for this privilege."
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "local_group",
"title": "local_group",
"_required_": false
}
],
"description": "`local_groups` is a list of local user account group GIDs that gain this privilege."
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "ds_group_gid",
"title": "ds_group_gid",
"_required_": false
},
{
"_name_": "ds_group_sid",
"title": "ds_group_sid",
"_required_": false,
"type": "string"
}
],
"description": "`ds_groups` is list of Directory Service group GIDs that will gain this privilege."
}
},
"additionalProperties": false,
"_name_": "privilege_update",
"title": "privilege_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"allowlist",
"roles",
"web_shell",
"local_groups",
"ds_groups"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update the privilege `id`.\nCreates a privilege."
},
"builtin_name": {
"_name_": "builtin_name",
"title": "builtin_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "`name` is a name for privilege (must be unique)."
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
],
"description": "`local_groups` is a list of local user account group GIDs that gain this privilege."
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
],
"description": "`ds_groups` is list of Directory Service group GIDs that will gain this privilege."
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
],
"description": "`allowlist` is a list of API endpoints allowed for this privilege."
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "privilege_update_returns",
"title": "privilege_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"builtin_name",
"name",
"local_groups",
"ds_groups",
"allowlist",
"roles",
"web_shell"
]
}
|
Update the privilege |
replication.count_eligible_manual_snapshots |
---|
Arguments:
{
"type": "object",
"properties": {
"datasets": {
"_name_": "datasets",
"title": "datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
]
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
],
"description": "Count how many existing snapshots of `dataset` match `naming_schema`."
},
"name_regex": {
"_name_": "name_regex",
"title": "name_regex",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"transport": {
"_name_": "transport",
"title": "transport",
"_required_": true,
"type": "string",
"enum": [
"SSH",
"SSH+NETCAT",
"LOCAL"
]
},
"ssh_credentials": {
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "count_eligible_manual_snapshots",
"title": "count_eligible_manual_snapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"datasets",
"naming_schema",
"name_regex",
"transport",
"ssh_credentials"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"total": {
"type": "integer",
"_name_": "total",
"title": "total",
"_required_": false
},
"eligible": {
"type": "integer",
"_name_": "eligible",
"title": "eligible",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "count_eligible_manual_snapshots",
"title": "count_eligible_manual_snapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"total",
"eligible"
]
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Count how many existing snapshots of |
|
replication.create |
---|
Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "* `name` specifies a name for replication task"
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
],
"description": "* `direction` specifies whether task will `PUSH` or `PULL` snapshots"
},
"transport": {
"_name_": "transport",
"title": "transport",
"_required_": true,
"type": "string",
"enum": [
"SSH",
"SSH+NETCAT",
"LOCAL"
],
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"ssh_credentials": {
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_active_side": {
"_name_": "netcat_active_side",
"title": "netcat_active_side",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LOCAL",
"REMOTE"
],
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_active_side_listen_address": {
"_name_": "netcat_active_side_listen_address",
"title": "netcat_active_side_listen_address",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"netcat_active_side_port_min": {
"type": [
"integer",
"null"
],
"_name_": "netcat_active_side_port_min",
"title": "netcat_active_side_port_min",
"default": null,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_active_side_port_max": {
"type": [
"integer",
"null"
],
"_name_": "netcat_active_side_port_max",
"title": "netcat_active_side_port_max",
"default": null,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_passive_side_connect_address": {
"_name_": "netcat_passive_side_connect_address",
"title": "netcat_passive_side_connect_address",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"sudo": {
"type": "boolean",
"_name_": "sudo",
"title": "sudo",
"default": false,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"source_datasets": {
"_name_": "source_datasets",
"title": "source_datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
],
"description": "* `source_datasets` is a non-empty list of datasets to replicate snapshots from"
},
"target_dataset": {
"_name_": "target_dataset",
"title": "target_dataset",
"_required_": true,
"type": "string",
"description": "* `target_dataset` is a dataset to put snapshots into. It must exist on target side"
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": true,
"description": "* `recursive` and `exclude` have the same meaning as for Periodic Snapshot Task"
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
],
"description": "* `recursive` and `exclude` have the same meaning as for Periodic Snapshot Task"
},
"properties": {
"type": "boolean",
"_name_": "properties",
"title": "properties",
"default": true,
"_required_": false,
"description": "* `properties` control whether we should send dataset properties along with snapshots"
},
"properties_exclude": {
"_name_": "properties_exclude",
"title": "properties_exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "property",
"title": "property",
"_required_": false,
"type": "string"
}
]
},
"properties_override": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties_override",
"title": "properties_override",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"replicate": {
"type": "boolean",
"_name_": "replicate",
"title": "replicate",
"default": false,
"_required_": false
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"encryption_inherit": {
"type": [
"boolean",
"null"
],
"_name_": "encryption_inherit",
"title": "encryption_inherit",
"default": null,
"_required_": false
},
"encryption_key": {
"_name_": "encryption_key",
"title": "encryption_key",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"encryption_key_format": {
"_name_": "encryption_key_format",
"title": "encryption_key_format",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"HEX",
"PASSPHRASE"
]
},
"encryption_key_location": {
"_name_": "encryption_key_location",
"title": "encryption_key_location",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"periodic_snapshot_tasks": {
"_name_": "periodic_snapshot_tasks",
"title": "periodic_snapshot_tasks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "periodic_snapshot_task",
"title": "periodic_snapshot_task",
"_required_": false
}
],
"description": "* `periodic_snapshot_tasks` is a list of periodic snapshot task IDs that are sources of snapshots for this\n replication task. Only push replication tasks can be bound to periodic snapshot tasks."
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
],
"description": "* `naming_schema` is a list of naming schemas for pull replication"
},
"also_include_naming_schema": {
"_name_": "also_include_naming_schema",
"title": "also_include_naming_schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
],
"description": "* `also_include_naming_schema` is a list of naming schemas for push replication"
},
"name_regex": {
"_name_": "name_regex",
"title": "name_regex",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "* `name_regex` will replicate all snapshots which names match specified regular expression"
},
"auto": {
"type": "boolean",
"_name_": "auto",
"title": "auto",
"_required_": true,
"description": "* `auto` allows replication to run automatically on schedule or after bound periodic snapshot task\n* `schedule` is a schedule to run replication task. Only `auto` replication tasks without bound periodic\n snapshot tasks can have a schedule"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": null,
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
],
"description": "* `auto` allows replication to run automatically on schedule or after bound periodic snapshot task\n* `schedule` is a schedule to run replication task. Only `auto` replication tasks without bound periodic\n snapshot tasks can have a schedule\n* Enabling `only_matching_schedule` will only replicate snapshots that match `schedule` or\n `restrict_schedule`"
},
"restrict_schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "restrict_schedule",
"title": "restrict_schedule",
"default": null,
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
],
"description": "* `restrict_schedule` restricts when replication task with bound periodic snapshot tasks runs. For example,\n you can have periodic snapshot tasks that run every 15 minutes, but only run replication task every hour.\n* Enabling `only_matching_schedule` will only replicate snapshots that match `schedule` or\n `restrict_schedule`"
},
"only_matching_schedule": {
"type": "boolean",
"_name_": "only_matching_schedule",
"title": "only_matching_schedule",
"default": false,
"_required_": false,
"description": "* Enabling `only_matching_schedule` will only replicate snapshots that match `schedule` or\n `restrict_schedule`"
},
"allow_from_scratch": {
"type": "boolean",
"_name_": "allow_from_scratch",
"title": "allow_from_scratch",
"default": false,
"_required_": false,
"description": "* `allow_from_scratch` will destroy all snapshots on target side and replicate everything from scratch if none\n of the snapshots on target side matches source snapshots"
},
"readonly": {
"_name_": "readonly",
"title": "readonly",
"default": "SET",
"_required_": false,
"type": "string",
"enum": [
"SET",
"REQUIRE",
"IGNORE"
],
"description": "* `readonly` controls destination datasets readonly property:\n * `SET` will set all destination datasets to readonly=on after finishing the replication\n * `REQUIRE` will require all existing destination datasets to have readonly=on property\n * `IGNORE` will avoid this kind of behavior"
},
"hold_pending_snapshots": {
"type": "boolean",
"_name_": "hold_pending_snapshots",
"title": "hold_pending_snapshots",
"default": false,
"_required_": false,
"description": "* `hold_pending_snapshots` will prevent source snapshots from being deleted by retention of replication fails\n for some reason"
},
"retention_policy": {
"_name_": "retention_policy",
"title": "retention_policy",
"_required_": true,
"type": "string",
"enum": [
"SOURCE",
"CUSTOM",
"NONE"
],
"description": "* `retention_policy` specifies how to delete old snapshots on target side:\n * `SOURCE` deletes snapshots that are absent on source side\n * `CUSTOM` deletes snapshots that are older than `lifetime_value` and `lifetime_unit`\n * `NONE` does not delete any snapshots"
},
"lifetime_value": {
"type": [
"integer",
"null"
],
"_name_": "lifetime_value",
"title": "lifetime_value",
"default": null,
"_required_": false,
"description": "* `retention_policy` specifies how to delete old snapshots on target side:\n * `SOURCE` deletes snapshots that are absent on source side\n * `CUSTOM` deletes snapshots that are older than `lifetime_value` and `lifetime_unit`\n * `NONE` does not delete any snapshots"
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
],
"description": "* `retention_policy` specifies how to delete old snapshots on target side:\n * `SOURCE` deletes snapshots that are absent on source side\n * `CUSTOM` deletes snapshots that are older than `lifetime_value` and `lifetime_unit`\n * `NONE` does not delete any snapshots"
},
"lifetimes": {
"_name_": "lifetimes",
"title": "lifetimes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "*",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"lifetime_value": {
"type": "integer",
"_name_": "lifetime_value",
"title": "lifetime_value",
"_required_": true
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"_required_": true,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
}
},
"additionalProperties": false,
"_name_": "lifetime",
"title": "lifetime",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"lifetime_value",
"lifetime_unit"
]
}
]
},
"compression": {
"_name_": "compression",
"title": "compression",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LZ4",
"PIGZ",
"PLZIP"
],
"description": "* `compression` compresses SSH stream. Available only for SSH transport"
},
"speed_limit": {
"type": [
"integer",
"null"
],
"_name_": "speed_limit",
"title": "speed_limit",
"default": null,
"_required_": false,
"description": "* `speed_limit` limits speed of SSH stream. Available only for SSH transport"
},
"large_block": {
"type": "boolean",
"_name_": "large_block",
"title": "large_block",
"default": true,
"_required_": false,
"description": "* `large_block`, `embed` and `compressed` are various ZFS stream flag documented in `man zfs send`"
},
"embed": {
"type": "boolean",
"_name_": "embed",
"title": "embed",
"default": false,
"_required_": false,
"description": "* `large_block`, `embed` and `compressed` are various ZFS stream flag documented in `man zfs send`"
},
"compressed": {
"type": "boolean",
"_name_": "compressed",
"title": "compressed",
"default": true,
"_required_": false,
"description": "* `large_block`, `embed` and `compressed` are various ZFS stream flag documented in `man zfs send`"
},
"retries": {
"type": "integer",
"_name_": "retries",
"title": "retries",
"default": 5,
"_required_": false,
"description": "* `retries` specifies number of retries before considering replication failed"
},
"logging_level": {
"_name_": "logging_level",
"title": "logging_level",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "replication_create",
"title": "replication_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"direction",
"transport",
"ssh_credentials",
"netcat_active_side",
"netcat_active_side_listen_address",
"netcat_active_side_port_min",
"netcat_active_side_port_max",
"netcat_passive_side_connect_address",
"sudo",
"source_datasets",
"target_dataset",
"recursive",
"exclude",
"properties",
"properties_exclude",
"properties_override",
"replicate",
"encryption",
"encryption_inherit",
"encryption_key",
"encryption_key_format",
"encryption_key_location",
"periodic_snapshot_tasks",
"naming_schema",
"also_include_naming_schema",
"name_regex",
"auto",
"schedule",
"restrict_schedule",
"only_matching_schedule",
"allow_from_scratch",
"readonly",
"hold_pending_snapshots",
"retention_policy",
"lifetime_value",
"lifetime_unit",
"lifetimes",
"compression",
"speed_limit",
"large_block",
"embed",
"compressed",
"retries",
"logging_level",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_create_returns",
"title": "replication_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Create a Replication Task Create a Replication Task that will push or pull ZFS snapshots to or from remote host..
|
|
replication.create_dataset |
---|
Arguments:
{
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string",
"description": "Accepts `dataset` name, `transport` and SSH credentials ID (for non-local transport)"
}
{
"_name_": "transport",
"title": "transport",
"_required_": true,
"type": "string",
"enum": [
"SSH",
"SSH+NETCAT",
"LOCAL"
],
"description": "Accepts `dataset` name, `transport` and SSH credentials ID (for non-local transport)"
}
{
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Creates dataset on remote side Accepts |
|
replication.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete a Replication Task with specific `id`"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Delete a Replication Task with specific |
|
replication.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_entry",
"title": "replication_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPLICATION_ADMIN, REPLICATION_TASK_READ, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL, SHARING_ADMIN |
Returns instance matching Please see |
replication.list_datasets |
---|
Arguments:
{
"_name_": "transport",
"title": "transport",
"_required_": true,
"type": "string",
"enum": [
"SSH",
"SSH+NETCAT",
"LOCAL"
],
"description": "Accepts `transport` and SSH credentials ID (for non-local transport)"
}
{
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false
}
|
Return Arguments:
{
"_name_": "datasets",
"title": "datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
List datasets on remote side Accepts |
|
replication.list_naming_schemas |
---|
Return Arguments:
{
"_name_": "naming_schemas",
"title": "naming_schemas",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
List all naming schemas used in periodic snapshot and replication tasks. |
replication.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_entry",
"title": "replication_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_entry",
"title": "replication_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_entry",
"title": "replication_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPLICATION_ADMIN, REPLICATION_TASK_READ, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL, SHARING_ADMIN |
- |
replication.restore |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"target_dataset": {
"_name_": "target_dataset",
"title": "target_dataset",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "replication_restore",
"title": "replication_restore",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"target_dataset"
]
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Create the opposite of replication task |
replication.run
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Run Replication Task of |
replication.run_onetime
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transport": {
"_name_": "transport",
"title": "transport",
"_required_": true,
"type": "string",
"enum": [
"SSH",
"SSH+NETCAT",
"LOCAL"
]
},
"ssh_credentials": {
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false
},
"netcat_active_side": {
"_name_": "netcat_active_side",
"title": "netcat_active_side",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LOCAL",
"REMOTE"
]
},
"netcat_active_side_listen_address": {
"_name_": "netcat_active_side_listen_address",
"title": "netcat_active_side_listen_address",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"netcat_active_side_port_min": {
"type": [
"integer",
"null"
],
"_name_": "netcat_active_side_port_min",
"title": "netcat_active_side_port_min",
"default": null,
"_required_": false
},
"netcat_active_side_port_max": {
"type": [
"integer",
"null"
],
"_name_": "netcat_active_side_port_max",
"title": "netcat_active_side_port_max",
"default": null,
"_required_": false
},
"netcat_passive_side_connect_address": {
"_name_": "netcat_passive_side_connect_address",
"title": "netcat_passive_side_connect_address",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"sudo": {
"type": "boolean",
"_name_": "sudo",
"title": "sudo",
"default": false,
"_required_": false
},
"source_datasets": {
"_name_": "source_datasets",
"title": "source_datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
]
},
"target_dataset": {
"_name_": "target_dataset",
"title": "target_dataset",
"_required_": true,
"type": "string"
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": true
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
]
},
"properties": {
"type": "boolean",
"_name_": "properties",
"title": "properties",
"default": true,
"_required_": false
},
"properties_exclude": {
"_name_": "properties_exclude",
"title": "properties_exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "property",
"title": "property",
"_required_": false,
"type": "string"
}
]
},
"properties_override": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties_override",
"title": "properties_override",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"replicate": {
"type": "boolean",
"_name_": "replicate",
"title": "replicate",
"default": false,
"_required_": false
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"encryption_inherit": {
"type": [
"boolean",
"null"
],
"_name_": "encryption_inherit",
"title": "encryption_inherit",
"default": null,
"_required_": false
},
"encryption_key": {
"_name_": "encryption_key",
"title": "encryption_key",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"encryption_key_format": {
"_name_": "encryption_key_format",
"title": "encryption_key_format",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"HEX",
"PASSPHRASE"
]
},
"encryption_key_location": {
"_name_": "encryption_key_location",
"title": "encryption_key_location",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"periodic_snapshot_tasks": {
"_name_": "periodic_snapshot_tasks",
"title": "periodic_snapshot_tasks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "periodic_snapshot_task",
"title": "periodic_snapshot_task",
"_required_": false
}
]
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
]
},
"also_include_naming_schema": {
"_name_": "also_include_naming_schema",
"title": "also_include_naming_schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
]
},
"name_regex": {
"_name_": "name_regex",
"title": "name_regex",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"restrict_schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "restrict_schedule",
"title": "restrict_schedule",
"default": null,
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
]
},
"allow_from_scratch": {
"type": "boolean",
"_name_": "allow_from_scratch",
"title": "allow_from_scratch",
"default": false,
"_required_": false
},
"readonly": {
"_name_": "readonly",
"title": "readonly",
"default": "SET",
"_required_": false,
"type": "string",
"enum": [
"SET",
"REQUIRE",
"IGNORE"
]
},
"hold_pending_snapshots": {
"type": "boolean",
"_name_": "hold_pending_snapshots",
"title": "hold_pending_snapshots",
"default": false,
"_required_": false
},
"retention_policy": {
"_name_": "retention_policy",
"title": "retention_policy",
"_required_": true,
"type": "string",
"enum": [
"SOURCE",
"CUSTOM",
"NONE"
]
},
"lifetime_value": {
"type": [
"integer",
"null"
],
"_name_": "lifetime_value",
"title": "lifetime_value",
"default": null,
"_required_": false
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
},
"lifetimes": {
"_name_": "lifetimes",
"title": "lifetimes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "*",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"lifetime_value": {
"type": "integer",
"_name_": "lifetime_value",
"title": "lifetime_value",
"_required_": true
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"_required_": true,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
}
},
"additionalProperties": false,
"_name_": "lifetime",
"title": "lifetime",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"lifetime_value",
"lifetime_unit"
]
}
]
},
"compression": {
"_name_": "compression",
"title": "compression",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LZ4",
"PIGZ",
"PLZIP"
]
},
"speed_limit": {
"type": [
"integer",
"null"
],
"_name_": "speed_limit",
"title": "speed_limit",
"default": null,
"_required_": false
},
"large_block": {
"type": "boolean",
"_name_": "large_block",
"title": "large_block",
"default": true,
"_required_": false
},
"embed": {
"type": "boolean",
"_name_": "embed",
"title": "embed",
"default": false,
"_required_": false
},
"compressed": {
"type": "boolean",
"_name_": "compressed",
"title": "compressed",
"default": true,
"_required_": false
},
"retries": {
"type": "integer",
"_name_": "retries",
"title": "retries",
"default": 5,
"_required_": false
},
"logging_level": {
"_name_": "logging_level",
"title": "logging_level",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR"
]
},
"exclude_mountpoint_property": {
"type": "boolean",
"_name_": "exclude_mountpoint_property",
"title": "exclude_mountpoint_property",
"default": true,
"_required_": false
},
"only_from_scratch": {
"type": "boolean",
"_name_": "only_from_scratch",
"title": "only_from_scratch",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "replication_run_onetime",
"title": "replication_run_onetime",
"default": {},
"_required_": false,
"_attrs_order_": [
"direction",
"transport",
"ssh_credentials",
"netcat_active_side",
"netcat_active_side_listen_address",
"netcat_active_side_port_min",
"netcat_active_side_port_max",
"netcat_passive_side_connect_address",
"sudo",
"source_datasets",
"target_dataset",
"recursive",
"exclude",
"properties",
"properties_exclude",
"properties_override",
"replicate",
"encryption",
"encryption_inherit",
"encryption_key",
"encryption_key_format",
"encryption_key_location",
"periodic_snapshot_tasks",
"naming_schema",
"also_include_naming_schema",
"name_regex",
"restrict_schedule",
"allow_from_scratch",
"readonly",
"hold_pending_snapshots",
"retention_policy",
"lifetime_value",
"lifetime_unit",
"lifetimes",
"compression",
"speed_limit",
"large_block",
"embed",
"compressed",
"retries",
"logging_level",
"exclude_mountpoint_property",
"only_from_scratch"
]
}
|
Run replication task without creating it. If |
replication.target_unmatched_snapshots |
---|
Arguments:
{
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
}
{
"_name_": "source_datasets",
"title": "source_datasets",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
]
}
{
"_name_": "target_dataset",
"title": "target_dataset",
"_required_": true,
"type": "string"
}
{
"_name_": "transport",
"title": "transport",
"_required_": true,
"type": "string",
"enum": [
"SSH",
"SSH+NETCAT",
"LOCAL",
"LEGACY"
]
}
{
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "target_unmatched_snapshots",
"title": "target_unmatched_snapshots",
"description": "\n\nExample(s):\n```\n{\n \"backup/work\": [\n \"auto-2019-10-15_13-00\",\n \"auto-2019-10-15_09-00\"\n ],\n \"backup/games\": [\n \"auto-2019-10-15_13-00\"\n ]\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Check if target has any snapshots that do not exist on source. Returns these snapshots grouped by dataset. |
|
replication.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update a Replication Task with specific `id`"
}
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"description": "* `name` specifies a name for replication task"
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
],
"description": "* `direction` specifies whether task will `PUSH` or `PULL` snapshots"
},
"transport": {
"_name_": "transport",
"title": "transport",
"_required_": true,
"type": "string",
"enum": [
"SSH",
"SSH+NETCAT",
"LOCAL"
],
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"ssh_credentials": {
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_active_side": {
"_name_": "netcat_active_side",
"title": "netcat_active_side",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LOCAL",
"REMOTE"
],
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_active_side_listen_address": {
"_name_": "netcat_active_side_listen_address",
"title": "netcat_active_side_listen_address",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"netcat_active_side_port_min": {
"type": [
"integer",
"null"
],
"_name_": "netcat_active_side_port_min",
"title": "netcat_active_side_port_min",
"default": null,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_active_side_port_max": {
"type": [
"integer",
"null"
],
"_name_": "netcat_active_side_port_max",
"title": "netcat_active_side_port_max",
"default": null,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"netcat_passive_side_connect_address": {
"_name_": "netcat_passive_side_connect_address",
"title": "netcat_passive_side_connect_address",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"sudo": {
"type": "boolean",
"_name_": "sudo",
"title": "sudo",
"default": false,
"_required_": false,
"description": "* `transport` is a method of snapshots transfer:\n * `SSH` transfers snapshots via SSH connection. This method is supported everywhere but does not achieve\n great performance\n `ssh_credentials` is a required field for this transport (Keychain Credential ID of type `SSH_CREDENTIALS`)\n * `SSH+NETCAT` uses unencrypted connection for data transfer. This can only be used in trusted networks\n and requires a port (specified by range from `netcat_active_side_port_min` to `netcat_active_side_port_max`)\n to be open on `netcat_active_side`\n `ssh_credentials` is also required for control connection\n * `LOCAL` replicates to or from localhost\n `sudo` flag controls whether `SSH` and `SSH+NETCAT` transports should use sudo (which is expected to be\n passwordless) to run `zfs` command on the remote machine."
},
"source_datasets": {
"_name_": "source_datasets",
"title": "source_datasets",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
],
"description": "* `source_datasets` is a non-empty list of datasets to replicate snapshots from"
},
"target_dataset": {
"_name_": "target_dataset",
"title": "target_dataset",
"_required_": true,
"type": "string",
"description": "* `target_dataset` is a dataset to put snapshots into. It must exist on target side"
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": true,
"description": "* `recursive` and `exclude` have the same meaning as for Periodic Snapshot Task"
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
],
"description": "* `recursive` and `exclude` have the same meaning as for Periodic Snapshot Task"
},
"properties": {
"type": "boolean",
"_name_": "properties",
"title": "properties",
"default": true,
"_required_": false,
"description": "* `properties` control whether we should send dataset properties along with snapshots"
},
"properties_exclude": {
"_name_": "properties_exclude",
"title": "properties_exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "property",
"title": "property",
"_required_": false,
"type": "string"
}
]
},
"properties_override": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties_override",
"title": "properties_override",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"replicate": {
"type": "boolean",
"_name_": "replicate",
"title": "replicate",
"default": false,
"_required_": false
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"encryption_inherit": {
"type": [
"boolean",
"null"
],
"_name_": "encryption_inherit",
"title": "encryption_inherit",
"default": null,
"_required_": false
},
"encryption_key": {
"_name_": "encryption_key",
"title": "encryption_key",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"encryption_key_format": {
"_name_": "encryption_key_format",
"title": "encryption_key_format",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"HEX",
"PASSPHRASE"
]
},
"encryption_key_location": {
"_name_": "encryption_key_location",
"title": "encryption_key_location",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"periodic_snapshot_tasks": {
"_name_": "periodic_snapshot_tasks",
"title": "periodic_snapshot_tasks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "periodic_snapshot_task",
"title": "periodic_snapshot_task",
"_required_": false
}
],
"description": "* `periodic_snapshot_tasks` is a list of periodic snapshot task IDs that are sources of snapshots for this\n replication task. Only push replication tasks can be bound to periodic snapshot tasks."
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
],
"description": "* `naming_schema` is a list of naming schemas for pull replication"
},
"also_include_naming_schema": {
"_name_": "also_include_naming_schema",
"title": "also_include_naming_schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
}
],
"description": "* `also_include_naming_schema` is a list of naming schemas for push replication"
},
"name_regex": {
"_name_": "name_regex",
"title": "name_regex",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "* `name_regex` will replicate all snapshots which names match specified regular expression"
},
"auto": {
"type": "boolean",
"_name_": "auto",
"title": "auto",
"_required_": true,
"description": "* `auto` allows replication to run automatically on schedule or after bound periodic snapshot task\n* `schedule` is a schedule to run replication task. Only `auto` replication tasks without bound periodic\n snapshot tasks can have a schedule"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": null,
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
],
"description": "* `auto` allows replication to run automatically on schedule or after bound periodic snapshot task\n* `schedule` is a schedule to run replication task. Only `auto` replication tasks without bound periodic\n snapshot tasks can have a schedule\n* Enabling `only_matching_schedule` will only replicate snapshots that match `schedule` or\n `restrict_schedule`"
},
"restrict_schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
},
"begin": {
"_name_": "begin",
"title": "begin",
"default": "00:00",
"_required_": false,
"type": "string"
},
"end": {
"_name_": "end",
"title": "end",
"default": "23:59",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "restrict_schedule",
"title": "restrict_schedule",
"default": null,
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow",
"begin",
"end"
],
"description": "* `restrict_schedule` restricts when replication task with bound periodic snapshot tasks runs. For example,\n you can have periodic snapshot tasks that run every 15 minutes, but only run replication task every hour.\n* Enabling `only_matching_schedule` will only replicate snapshots that match `schedule` or\n `restrict_schedule`"
},
"only_matching_schedule": {
"type": "boolean",
"_name_": "only_matching_schedule",
"title": "only_matching_schedule",
"default": false,
"_required_": false,
"description": "* Enabling `only_matching_schedule` will only replicate snapshots that match `schedule` or\n `restrict_schedule`"
},
"allow_from_scratch": {
"type": "boolean",
"_name_": "allow_from_scratch",
"title": "allow_from_scratch",
"default": false,
"_required_": false,
"description": "* `allow_from_scratch` will destroy all snapshots on target side and replicate everything from scratch if none\n of the snapshots on target side matches source snapshots"
},
"readonly": {
"_name_": "readonly",
"title": "readonly",
"default": "SET",
"_required_": false,
"type": "string",
"enum": [
"SET",
"REQUIRE",
"IGNORE"
],
"description": "* `readonly` controls destination datasets readonly property:\n * `SET` will set all destination datasets to readonly=on after finishing the replication\n * `REQUIRE` will require all existing destination datasets to have readonly=on property\n * `IGNORE` will avoid this kind of behavior"
},
"hold_pending_snapshots": {
"type": "boolean",
"_name_": "hold_pending_snapshots",
"title": "hold_pending_snapshots",
"default": false,
"_required_": false,
"description": "* `hold_pending_snapshots` will prevent source snapshots from being deleted by retention of replication fails\n for some reason"
},
"retention_policy": {
"_name_": "retention_policy",
"title": "retention_policy",
"_required_": true,
"type": "string",
"enum": [
"SOURCE",
"CUSTOM",
"NONE"
],
"description": "* `retention_policy` specifies how to delete old snapshots on target side:\n * `SOURCE` deletes snapshots that are absent on source side\n * `CUSTOM` deletes snapshots that are older than `lifetime_value` and `lifetime_unit`\n * `NONE` does not delete any snapshots"
},
"lifetime_value": {
"type": [
"integer",
"null"
],
"_name_": "lifetime_value",
"title": "lifetime_value",
"default": null,
"_required_": false,
"description": "* `retention_policy` specifies how to delete old snapshots on target side:\n * `SOURCE` deletes snapshots that are absent on source side\n * `CUSTOM` deletes snapshots that are older than `lifetime_value` and `lifetime_unit`\n * `NONE` does not delete any snapshots"
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
],
"description": "* `retention_policy` specifies how to delete old snapshots on target side:\n * `SOURCE` deletes snapshots that are absent on source side\n * `CUSTOM` deletes snapshots that are older than `lifetime_value` and `lifetime_unit`\n * `NONE` does not delete any snapshots"
},
"lifetimes": {
"_name_": "lifetimes",
"title": "lifetimes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "*",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"lifetime_value": {
"type": "integer",
"_name_": "lifetime_value",
"title": "lifetime_value",
"_required_": true
},
"lifetime_unit": {
"_name_": "lifetime_unit",
"title": "lifetime_unit",
"_required_": true,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
}
},
"additionalProperties": false,
"_name_": "lifetime",
"title": "lifetime",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"lifetime_value",
"lifetime_unit"
]
}
]
},
"compression": {
"_name_": "compression",
"title": "compression",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"LZ4",
"PIGZ",
"PLZIP"
],
"description": "* `compression` compresses SSH stream. Available only for SSH transport"
},
"speed_limit": {
"type": [
"integer",
"null"
],
"_name_": "speed_limit",
"title": "speed_limit",
"default": null,
"_required_": false,
"description": "* `speed_limit` limits speed of SSH stream. Available only for SSH transport"
},
"large_block": {
"type": "boolean",
"_name_": "large_block",
"title": "large_block",
"default": true,
"_required_": false,
"description": "* `large_block`, `embed` and `compressed` are various ZFS stream flag documented in `man zfs send`"
},
"embed": {
"type": "boolean",
"_name_": "embed",
"title": "embed",
"default": false,
"_required_": false,
"description": "* `large_block`, `embed` and `compressed` are various ZFS stream flag documented in `man zfs send`"
},
"compressed": {
"type": "boolean",
"_name_": "compressed",
"title": "compressed",
"default": true,
"_required_": false,
"description": "* `large_block`, `embed` and `compressed` are various ZFS stream flag documented in `man zfs send`"
},
"retries": {
"type": "integer",
"_name_": "retries",
"title": "retries",
"default": 5,
"_required_": false,
"description": "* `retries` specifies number of retries before considering replication failed"
},
"logging_level": {
"_name_": "logging_level",
"title": "logging_level",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"enum": [
"DEBUG",
"INFO",
"WARNING",
"ERROR"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "replication_update",
"title": "replication_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"direction",
"transport",
"ssh_credentials",
"netcat_active_side",
"netcat_active_side_listen_address",
"netcat_active_side_port_min",
"netcat_active_side_port_max",
"netcat_passive_side_connect_address",
"sudo",
"source_datasets",
"target_dataset",
"recursive",
"exclude",
"properties",
"properties_exclude",
"properties_override",
"replicate",
"encryption",
"encryption_inherit",
"encryption_key",
"encryption_key_format",
"encryption_key_location",
"periodic_snapshot_tasks",
"naming_schema",
"also_include_naming_schema",
"name_regex",
"auto",
"schedule",
"restrict_schedule",
"only_matching_schedule",
"allow_from_scratch",
"readonly",
"hold_pending_snapshots",
"retention_policy",
"lifetime_value",
"lifetime_unit",
"lifetimes",
"compression",
"speed_limit",
"large_block",
"embed",
"compressed",
"retries",
"logging_level",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_update_returns",
"title": "replication_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_WRITE, REPLICATION_TASK_WRITE_PULL |
Update a Replication Task with specific See the documentation for |
|
replication.config.config |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_config_entry",
"title": "replication_config_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPLICATION_ADMIN, REPLICATION_TASK_CONFIG_READ, REPLICATION_TASK_CONFIG_WRITE, SHARING_ADMIN |
- |
replication.config.update |
---|
Arguments:
{
"type": "object",
"properties": {
"max_parallel_replication_tasks": {
"type": [
"integer",
"null"
],
"_name_": "max_parallel_replication_tasks",
"title": "max_parallel_replication_tasks",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "replication_config_update",
"title": "replication_config_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"max_parallel_replication_tasks"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_config_update_returns",
"title": "replication_config_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, REPLICATION_TASK_CONFIG_WRITE |
|
reporting.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"tier1_days": {
"type": "integer",
"_name_": "tier1_days",
"title": "tier1_days",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "reporting_entry",
"title": "reporting_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"tier1_days"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
- |
reporting.get_data |
---|
Arguments:
{
"_name_": "graphs",
"title": "graphs",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"enum": [
"cpu",
"cputemp",
"disk",
"interface",
"load",
"processes",
"memory",
"uptime",
"arcactualrate",
"arcrate",
"arcsize",
"arcresult",
"disktemp",
"upscharge",
"upsruntime",
"upsvoltage",
"upscurrent",
"upsfrequency",
"upsload",
"upstemperature"
]
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "graph",
"title": "graph",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"identifier"
]
}
]
}
{
"type": "object",
"properties": {
"unit": {
"_name_": "unit",
"title": "unit",
"_required_": false,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
],
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"page": {
"type": "integer",
"_name_": "page",
"title": "page",
"default": 1,
"_required_": false,
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"start": {
"type": "integer",
"_name_": "start",
"title": "start",
"_required_": false,
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"end": {
"type": "integer",
"_name_": "end",
"title": "end",
"_required_": false,
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"aggregate": {
"type": "boolean",
"_name_": "aggregate",
"title": "aggregate",
"default": true,
"_required_": false,
"description": "`aggregate` will return aggregate available data for each graph (e.g. min, max, mean)."
}
},
"additionalProperties": false,
"_name_": "reporting_query",
"title": "reporting_query",
"default": {},
"_required_": false,
"_attrs_order_": [
"unit",
"page",
"start",
"end",
"aggregate"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": [
"string",
"null"
]
},
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"aggregations": {
"type": "object",
"properties": {
"min": {
"_name_": "min",
"title": "min",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"max": {
"_name_": "max",
"title": "max",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"mean": {
"_name_": "mean",
"title": "mean",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "aggregations",
"title": "aggregations",
"default": {},
"_required_": false,
"_attrs_order_": [
"min",
"max",
"mean"
]
}
},
"additionalProperties": true,
"_name_": "netdata_graph_reporting_data",
"title": "netdata_graph_reporting_data",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"identifier",
"data",
"aggregations"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Get reporting data for given graphs. List of possible graphs can be retrieved using For the time period of the graph either
|
Get graph data of "nfsstat" from the last hour.
|
reporting.graph |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
}
{
"type": "object",
"properties": {
"unit": {
"_name_": "unit",
"title": "unit",
"_required_": false,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
},
"page": {
"type": "integer",
"_name_": "page",
"title": "page",
"default": 1,
"_required_": false
},
"start": {
"type": "integer",
"_name_": "start",
"title": "start",
"_required_": false
},
"end": {
"type": "integer",
"_name_": "end",
"title": "end",
"_required_": false
},
"aggregate": {
"type": "boolean",
"_name_": "aggregate",
"title": "aggregate",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reporting_query",
"title": "reporting_query",
"default": {},
"_required_": false,
"_attrs_order_": [
"unit",
"page",
"start",
"end",
"aggregate"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": [
"string",
"null"
]
},
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"aggregations": {
"type": "object",
"properties": {
"min": {
"_name_": "min",
"title": "min",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"max": {
"_name_": "max",
"title": "max",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"mean": {
"_name_": "mean",
"title": "mean",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "aggregations",
"title": "aggregations",
"default": {},
"_required_": false,
"_attrs_order_": [
"min",
"max",
"mean"
]
}
},
"additionalProperties": true,
"_name_": "netdata_graph_reporting_data",
"title": "netdata_graph_reporting_data",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"identifier",
"data",
"aggregations"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Get reporting data for |
reporting.graphs |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"vertical_label": {
"_name_": "vertical_label",
"title": "vertical_label",
"_required_": false,
"type": "string"
},
"identifiers": {
"_name_": "identifiers",
"title": "identifiers",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "identifier",
"title": "identifier",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "reporting_graph",
"title": "reporting_graph",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"title",
"vertical_label",
"identifiers"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"vertical_label": {
"_name_": "vertical_label",
"title": "vertical_label",
"_required_": false,
"type": "string"
},
"identifiers": {
"_name_": "identifiers",
"title": "identifiers",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "identifier",
"title": "identifier",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "reporting_graph",
"title": "reporting_graph",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"title",
"vertical_label",
"identifiers"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
- |
reporting.netdata_get_data |
---|
Arguments:
{
"_name_": "graphs",
"title": "graphs",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string",
"enum": [
"cpu",
"cputemp",
"disk",
"interface",
"load",
"processes",
"memory",
"uptime",
"arcactualrate",
"arcrate",
"arcsize",
"arcresult",
"disktemp",
"upscharge",
"upsruntime",
"upsvoltage",
"upscurrent",
"upsfrequency",
"upsload",
"upstemperature"
]
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "graph",
"title": "graph",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"identifier"
]
}
]
}
{
"type": "object",
"properties": {
"unit": {
"_name_": "unit",
"title": "unit",
"_required_": false,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
],
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"page": {
"type": "integer",
"_name_": "page",
"title": "page",
"default": 1,
"_required_": false,
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"start": {
"type": "integer",
"_name_": "start",
"title": "start",
"_required_": false,
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"end": {
"type": "integer",
"_name_": "end",
"title": "end",
"_required_": false,
"description": "For the time period of the graph either `unit` and `page` OR `start` and `end` should be\nused, not both."
},
"aggregate": {
"type": "boolean",
"_name_": "aggregate",
"title": "aggregate",
"default": true,
"_required_": false,
"description": "`aggregate` will return aggregate available data for each graph (e.g. min, max, mean)."
}
},
"additionalProperties": false,
"_name_": "reporting_query",
"title": "reporting_query",
"default": {},
"_required_": false,
"_attrs_order_": [
"unit",
"page",
"start",
"end",
"aggregate"
]
}
|
Return Arguments:
{
"_name_": "reporting_data",
"title": "reporting_data",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": [
"string",
"null"
]
},
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"aggregations": {
"type": "object",
"properties": {
"min": {
"_name_": "min",
"title": "min",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"max": {
"_name_": "max",
"title": "max",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"mean": {
"_name_": "mean",
"title": "mean",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "aggregations",
"title": "aggregations",
"default": {},
"_required_": false,
"_attrs_order_": [
"min",
"max",
"mean"
]
}
},
"additionalProperties": true,
"_name_": "netdata_graph_reporting_data",
"title": "netdata_graph_reporting_data",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"identifier",
"data",
"aggregations"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Get reporting data for given graphs. List of possible graphs can be retrieved using For the time period of the graph either
|
Get graph data of "nfsstat" from the last hour.
|
reporting.netdata_graph |
---|
Arguments:
{
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
}
{
"type": "object",
"properties": {
"unit": {
"_name_": "unit",
"title": "unit",
"_required_": false,
"type": "string",
"enum": [
"HOUR",
"DAY",
"WEEK",
"MONTH",
"YEAR"
]
},
"page": {
"type": "integer",
"_name_": "page",
"title": "page",
"default": 1,
"_required_": false
},
"start": {
"type": "integer",
"_name_": "start",
"title": "start",
"_required_": false
},
"end": {
"type": "integer",
"_name_": "end",
"title": "end",
"_required_": false
},
"aggregate": {
"type": "boolean",
"_name_": "aggregate",
"title": "aggregate",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reporting_query",
"title": "reporting_query",
"default": {},
"_required_": false,
"_attrs_order_": [
"unit",
"page",
"start",
"end",
"aggregate"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": [
"string",
"null"
]
},
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"aggregations": {
"type": "object",
"properties": {
"min": {
"_name_": "min",
"title": "min",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"max": {
"_name_": "max",
"title": "max",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"mean": {
"_name_": "mean",
"title": "mean",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "aggregations",
"title": "aggregations",
"default": {},
"_required_": false,
"_attrs_order_": [
"min",
"max",
"mean"
]
}
},
"additionalProperties": true,
"_name_": "netdata_graph_reporting_data",
"title": "netdata_graph_reporting_data",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"identifier",
"data",
"aggregations"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Get reporting data for |
reporting.netdata_graphs |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"vertical_label": {
"_name_": "vertical_label",
"title": "vertical_label",
"_required_": false,
"type": "string"
},
"identifiers": {
"_name_": "identifiers",
"title": "identifiers",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "identifier",
"title": "identifier",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "reporting_graph",
"title": "reporting_graph",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"title",
"vertical_label",
"identifiers"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"vertical_label": {
"_name_": "vertical_label",
"title": "vertical_label",
"_required_": false,
"type": "string"
},
"identifiers": {
"_name_": "identifiers",
"title": "identifiers",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "identifier",
"title": "identifier",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "reporting_graph",
"title": "reporting_graph",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"title",
"vertical_label",
"identifiers"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Get reporting netdata graphs. |
reporting.netdataweb_generate_password |
---|
Return Arguments:
{
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Generate a password to access netdata web. That password will be stored in htpasswd format for HTTP Basic access. Concurrent access for the same user is not supported and may lead to undesired behavior. |
reporting.update |
---|
Arguments:
{
"type": "object",
"properties": {
"tier1_days": {
"type": "integer",
"_name_": "tier1_days",
"title": "tier1_days",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "reporting_update",
"title": "reporting_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"tier1_days"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"tier1_days": {
"type": "integer",
"_name_": "tier1_days",
"title": "tier1_days",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "reporting_update_returns",
"title": "reporting_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"tier1_days"
]
}
|
This method is accessible to the users granted with the following roles: REPORTING_WRITE |
|
reporting.exporters.create |
---|
Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporters_create",
"title": "reporting_exporters_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"type",
"attributes",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporters_create_returns",
"title": "reporting_exporters_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"type",
"attributes",
"name"
]
}
|
This method is accessible to the users granted with the following roles: REPORTING_WRITE |
Create a specific reporting exporter configuration containing required details for exporting reporting metrics. |
reporting.exporters.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: REPORTING_WRITE |
Delete Reporting Exporter of |
reporting.exporters.exporter_schemas |
---|
Return Arguments:
{
"_name_": "exporter_schemas",
"title": "Reporting Exporter Schemas",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"key": {
"_name_": "key",
"title": "key",
"_required_": true,
"type": "string"
},
"schema": {
"_name_": "schema",
"title": "schema",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attribute_schema",
"title": "Attribute Schema",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
}
},
"additionalProperties": false,
"_name_": "schema_entry",
"title": "Reporting Exporter Schema",
"default": {},
"_required_": false,
"_attrs_order_": [
"key",
"schema"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Get the schemas for all the reporting export types we support with their respective attributes required for successfully exporting reporting metrics to them. |
reporting.exporters.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporter_entry",
"title": "reporting_exporter_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"type",
"attributes",
"name"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Returns instance matching Please see |
reporting.exporters.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporter_entry",
"title": "reporting_exporter_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"type",
"attributes",
"name"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporter_entry",
"title": "reporting_exporter_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"type",
"attributes",
"name"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporter_entry",
"title": "reporting_exporter_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"type",
"attributes",
"name"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
- |
reporting.exporters.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporter_update",
"title": "reporting_exporter_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"attributes",
"name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporters_update_returns",
"title": "reporting_exporters_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"type",
"attributes",
"name"
]
}
|
This method is accessible to the users granted with the following roles: REPORTING_WRITE |
Update Reporting Exporter of |
route.ipv4gw_reachable |
---|
Arguments:
{
"_name_": "ipv4_gateway",
"title": "ipv4_gateway",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "ipv4gw_reachable",
"title": "ipv4gw_reachable",
"_required_": false
}
|
Get the IPv4 gateway and verify if it is reachable by any interface. Returns: bool: True if the gateway is reachable or otherwise False. |
route.system_routes |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"network": {
"_name_": "network",
"title": "network",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": [
"string",
"null"
]
},
"interface": {
"_name_": "interface",
"title": "interface",
"_required_": true,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"table_id": {
"type": "integer",
"_name_": "table_id",
"title": "table_id",
"_required_": true
},
"scope": {
"type": "integer",
"_name_": "scope",
"title": "scope",
"_required_": true
},
"preferred_source": {
"_name_": "preferred_source",
"title": "preferred_source",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "system_route",
"title": "system_route",
"default": {},
"_required_": false,
"_attrs_order_": [
"network",
"netmask",
"gateway",
"interface",
"flags",
"table_id",
"scope",
"preferred_source"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"network": {
"_name_": "network",
"title": "network",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": [
"string",
"null"
]
},
"interface": {
"_name_": "interface",
"title": "interface",
"_required_": true,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"table_id": {
"type": "integer",
"_name_": "table_id",
"title": "table_id",
"_required_": true
},
"scope": {
"type": "integer",
"_name_": "scope",
"title": "scope",
"_required_": true
},
"preferred_source": {
"_name_": "preferred_source",
"title": "preferred_source",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "system_route",
"title": "system_route",
"default": {},
"_required_": false,
"_attrs_order_": [
"network",
"netmask",
"gateway",
"interface",
"flags",
"table_id",
"scope",
"preferred_source"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
Get current/applied network routes. |
rsynctask.create |
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "See the comment in Rsyncmod about `path` length limits."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string",
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
],
"description": "`mode` represents different operating mechanisms for Rsync i.e Rsync Module mode / Rsync SSH mode.\n`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotehost` is ip address or hostname of the remote system. If username differs on the remote host,\n\"username@remote_host\" format should be used.\n`remotehost` and `remoteport` are not used in this case."
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false,
"description": "`remotehost` and `remoteport` are not used in this case."
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"ssh_credentials": {
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false,
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string",
"description": "`remotepath` specifies the path on the remote system."
},
"validate_rpath": {
"type": "boolean",
"_name_": "validate_rpath",
"title": "validate_rpath",
"default": true,
"_required_": false,
"description": "`validate_rpath` is a boolean which when sets validates the existence of the remote path."
},
"ssh_keyscan": {
"type": "boolean",
"_name_": "ssh_keyscan",
"title": "ssh_keyscan",
"default": false,
"_required_": false,
"description": "`ssh_keyscan` will automatically add remote host key to user's known_hosts file."
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
],
"description": "`direction` specifies if data should be PULLED or PUSHED from the remote system."
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false,
"description": "`compress` when set reduces the size of the data which is to be transmitted."
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false,
"description": "`archive` when set makes rsync run recursively, preserving symlinks, permissions, modification times, group,\nand special files."
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false,
"description": "`delete` when set deletes files in the destination directory which do not exist in the source directory."
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false,
"description": "`preserveperm` when set preserves original file permissions."
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "rsync_task_create",
"title": "rsync_task_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"ssh_credentials",
"remotepath",
"validate_rpath",
"ssh_keyscan",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "See the comment in Rsyncmod about `path` length limits."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string",
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
],
"description": "`mode` represents different operating mechanisms for Rsync i.e Rsync Module mode / Rsync SSH mode.\n`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotehost` is ip address or hostname of the remote system. If username differs on the remote host,\n\"username@remote_host\" format should be used.\n`remotehost` and `remoteport` are not used in this case."
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false,
"description": "`remotehost` and `remoteport` are not used in this case."
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string",
"description": "`remotepath` specifies the path on the remote system."
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
],
"description": "`direction` specifies if data should be PULLED or PUSHED from the remote system."
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false,
"description": "`compress` when set reduces the size of the data which is to be transmitted."
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false,
"description": "`archive` when set makes rsync run recursively, preserving symlinks, permissions, modification times, group,\nand special files."
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false,
"description": "`delete` when set deletes files in the destination directory which do not exist in the source directory."
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false,
"description": "`preserveperm` when set preserves original file permissions."
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ssh_credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": {},
"_required_": false,
"_attrs_order_": [],
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "rsynctask_create_returns",
"title": "rsynctask_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"remotepath",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled",
"id",
"ssh_credentials",
"locked",
"job"
]
}
|
Create a Rsync Task. See the comment in Rsyncmod about
In SSH mode, if
|
Create a Rsync Task which pulls data from a remote system every 5 minutes.
|
rsynctask.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete Rsync Task of |
rsynctask.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
]
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string"
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"ssh_credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "rsync_task_entry",
"title": "rsync_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"remotepath",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled",
"id",
"ssh_credentials",
"locked",
"job"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
rsynctask.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
]
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string"
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ssh_credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "rsync_task_entry",
"title": "rsync_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"remotepath",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled",
"id",
"ssh_credentials",
"locked",
"job"
]
}
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
]
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string"
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ssh_credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "rsync_task_entry",
"title": "rsync_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"remotepath",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled",
"id",
"ssh_credentials",
"locked",
"job"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
]
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string"
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ssh_credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "rsync_task_entry",
"title": "rsync_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"remotepath",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled",
"id",
"ssh_credentials",
"locked",
"job"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
rsynctask.run
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Job to run rsync task of `id`."
}
|
Job to run rsync task of Output is saved to job log excerpt (not syslog). |
rsynctask.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Rsync Task of `id`.\nCreate a Rsync Task."
}
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "See the comment in Rsyncmod about `path` length limits."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string",
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
],
"description": "`mode` represents different operating mechanisms for Rsync i.e Rsync Module mode / Rsync SSH mode.\n`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotehost` is ip address or hostname of the remote system. If username differs on the remote host,\n\"username@remote_host\" format should be used.\n`remotehost` and `remoteport` are not used in this case."
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false,
"description": "`remotehost` and `remoteport` are not used in this case."
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"ssh_credentials": {
"type": [
"integer",
"null"
],
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": null,
"_required_": false,
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string",
"description": "`remotepath` specifies the path on the remote system."
},
"validate_rpath": {
"type": "boolean",
"_name_": "validate_rpath",
"title": "validate_rpath",
"default": true,
"_required_": false,
"description": "`validate_rpath` is a boolean which when sets validates the existence of the remote path."
},
"ssh_keyscan": {
"type": "boolean",
"_name_": "ssh_keyscan",
"title": "ssh_keyscan",
"default": false,
"_required_": false,
"description": "`ssh_keyscan` will automatically add remote host key to user's known_hosts file."
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
],
"description": "`direction` specifies if data should be PULLED or PUSHED from the remote system."
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false,
"description": "`compress` when set reduces the size of the data which is to be transmitted."
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false,
"description": "`archive` when set makes rsync run recursively, preserving symlinks, permissions, modification times, group,\nand special files."
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false,
"description": "`delete` when set deletes files in the destination directory which do not exist in the source directory."
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false,
"description": "`preserveperm` when set preserves original file permissions."
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "rsync_task_update",
"title": "rsync_task_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"ssh_credentials",
"remotepath",
"validate_rpath",
"ssh_keyscan",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "See the comment in Rsyncmod about `path` length limits."
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string",
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
],
"description": "`mode` represents different operating mechanisms for Rsync i.e Rsync Module mode / Rsync SSH mode.\n`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotehost` is ip address or hostname of the remote system. If username differs on the remote host,\n\"username@remote_host\" format should be used.\n`remotehost` and `remoteport` are not used in this case."
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false,
"description": "`remotehost` and `remoteport` are not used in this case."
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`remotemodule` is the name of remote module, this attribute should be specified when `mode` is set to MODULE."
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string",
"description": "`remotepath` specifies the path on the remote system."
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
],
"description": "`direction` specifies if data should be PULLED or PUSHED from the remote system."
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false,
"description": "`compress` when set reduces the size of the data which is to be transmitted."
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false,
"description": "`archive` when set makes rsync run recursively, preserving symlinks, permissions, modification times, group,\nand special files."
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false,
"description": "`delete` when set deletes files in the destination directory which do not exist in the source directory."
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false,
"description": "`preserveperm` when set preserves original file permissions."
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Rsync Task of `id`.\nCreate a Rsync Task."
},
"ssh_credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": {},
"_required_": false,
"_attrs_order_": [],
"description": "In SSH mode, if `ssh_credentials` (a keychain credential of `SSH_CREDENTIALS` type) is specified then it is used\nto connect to the remote host. If it is not specified, then keys in `user`'s .ssh directory are used."
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "rsynctask_update_returns",
"title": "rsynctask_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"remotepath",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled",
"id",
"ssh_credentials",
"locked",
"job"
]
}
|
Update Rsync Task of |
service.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"pids": {
"_name_": "pids",
"title": "pids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": false
}
]
}
},
"additionalProperties": false,
"_name_": "service_entry",
"title": "service_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service",
"enable",
"state",
"pids"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SERVICE_READ, SHARING_ADMIN |
Returns instance matching Please see |
service.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"pids": {
"_name_": "pids",
"title": "pids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": false
}
]
}
},
"additionalProperties": false,
"_name_": "service_entry",
"title": "service_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service",
"enable",
"state",
"pids"
]
}
]
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"pids": {
"_name_": "pids",
"title": "pids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": false
}
]
}
},
"additionalProperties": false,
"_name_": "service_entry",
"title": "service_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service",
"enable",
"state",
"pids"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"pids": {
"_name_": "pids",
"title": "pids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": false
}
]
}
},
"additionalProperties": false,
"_name_": "service_entry",
"title": "service_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service",
"enable",
"state",
"pids"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SERVICE_READ, SHARING_ADMIN |
Query all system services with Supports the following extra options:
|
service.reload |
---|
Arguments:
{
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"ha_propagate": {
"type": "boolean",
"_name_": "ha_propagate",
"title": "ha_propagate",
"default": true,
"_required_": false
},
"silent": {
"type": "boolean",
"_name_": "silent",
"title": "silent",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service-control",
"title": "service-control",
"default": {},
"_required_": false,
"_attrs_order_": [
"ha_propagate",
"silent"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "service_reloaded",
"title": "service_reloaded",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SERVICE_WRITE, SHARING_ADMIN, SHARING_ISCSI_WRITE, SHARING_NFS_WRITE, SHARING_SMB_WRITE, SHARING_WRITE |
Reload the service specified by |
service.restart |
---|
Arguments:
{
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"ha_propagate": {
"type": "boolean",
"_name_": "ha_propagate",
"title": "ha_propagate",
"default": true,
"_required_": false
},
"silent": {
"type": "boolean",
"_name_": "silent",
"title": "silent",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service-control",
"title": "service-control",
"default": {},
"_required_": false,
"_attrs_order_": [
"ha_propagate",
"silent"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "service_restarted",
"title": "service_restarted",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SERVICE_WRITE, SHARING_ADMIN, SHARING_ISCSI_WRITE, SHARING_NFS_WRITE, SHARING_SMB_WRITE, SHARING_WRITE |
Restart the service specified by |
service.start |
---|
Arguments:
{
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string",
"description": "Start the service specified by `service`."
}
{
"type": "object",
"properties": {
"ha_propagate": {
"type": "boolean",
"_name_": "ha_propagate",
"title": "ha_propagate",
"default": true,
"_required_": false
},
"silent": {
"type": "boolean",
"_name_": "silent",
"title": "silent",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service-control",
"title": "service-control",
"default": {},
"_required_": false,
"_attrs_order_": [
"ha_propagate",
"silent"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "started_service",
"title": "started_service",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SERVICE_WRITE, SHARING_ADMIN, SHARING_ISCSI_WRITE, SHARING_NFS_WRITE, SHARING_SMB_WRITE, SHARING_WRITE |
Start the service specified by If |
service.started |
---|
Arguments:
{
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "service_started",
"title": "service_started",
"description": "Will return `true` if service is running",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SERVICE_READ, SHARING_ADMIN |
Test if service specified by |
service.started_or_enabled |
---|
Arguments:
{
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "service_started_or_enabled",
"title": "service_started_or_enabled",
"description": "Will return `true` if service is started or enabled to start automatically.",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SERVICE_READ, SHARING_ADMIN |
Test if service specified by |
service.stop |
---|
Arguments:
{
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"ha_propagate": {
"type": "boolean",
"_name_": "ha_propagate",
"title": "ha_propagate",
"default": true,
"_required_": false
},
"silent": {
"type": "boolean",
"_name_": "silent",
"title": "silent",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service-control",
"title": "service-control",
"default": {},
"_required_": false,
"_attrs_order_": [
"ha_propagate",
"silent"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "service_stopped",
"title": "service_stopped",
"description": "Will return `true` if service successfully stopped",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SERVICE_WRITE, SHARING_ADMIN, SHARING_ISCSI_WRITE, SHARING_NFS_WRITE, SHARING_SMB_WRITE, SHARING_WRITE |
Stop the service specified by |
service.terminate_process |
---|
Arguments:
{
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": false,
"description": "Terminate process by `pid`."
}
{
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "process_terminated_nicely",
"title": "process_terminated_nicely",
"description": "`true` is process has been successfully terminated with `TERM` and `false` if we had to use `KILL`",
"_required_": false
}
|
Terminate process by First send |
service.update |
---|
Arguments:
{
"_name_": "id_or_name",
"title": "id_or_name",
"_required_": false,
"type": "string",
"description": "Update service entry of `id_or_name`."
}
{
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "service-update",
"title": "service-update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable"
]
}
|
Return Arguments:
{
"type": "integer",
"_name_": "service_primary_key",
"title": "service_primary_key",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SERVICE_WRITE, SHARING_ADMIN, SHARING_ISCSI_WRITE, SHARING_NFS_WRITE, SHARING_SMB_WRITE, SHARING_WRITE |
Update service entry of Currently, it only accepts |
sharing.nfs.create |
---|
Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "`path` local path to be exported."
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
],
"description": "`aliases` IGNORED, for now."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
],
"description": "`networks` is a list of authorized networks that are allowed to access the share having format\n\"network/mask\" CIDR notation. If empty, all networks are allowed."
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharingnfs_create",
"title": "sharingnfs_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "`path` local path to be exported."
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
],
"description": "`aliases` IGNORED, for now."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
],
"description": "`networks` is a list of authorized networks that are allowed to access the share having format\n\"network/mask\" CIDR notation. If empty, all networks are allowed."
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharing_nfs_create_returns",
"title": "sharing_nfs_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled",
"id",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_NFS_WRITE, SHARING_WRITE |
Create a NFS Share.
|
sharing.nfs.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_NFS_WRITE, SHARING_WRITE |
Delete NFS Share of |
sharing.nfs.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
]
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharing_nfs_entry",
"title": "sharing_nfs_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled",
"id",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_NFS_READ, SHARING_NFS_WRITE, SHARING_READ, SHARING_WRITE |
Returns instance matching Please see |
sharing.nfs.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
]
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharing_nfs_entry",
"title": "sharing_nfs_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled",
"id",
"locked"
]
}
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
]
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharing_nfs_entry",
"title": "sharing_nfs_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled",
"id",
"locked"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
]
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharing_nfs_entry",
"title": "sharing_nfs_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled",
"id",
"locked"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_NFS_READ, SHARING_NFS_WRITE, SHARING_READ, SHARING_WRITE |
- |
sharing.nfs.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update NFS Share of `id`.\nCreate a NFS Share."
}
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "`path` local path to be exported."
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
],
"description": "`aliases` IGNORED, for now."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
],
"description": "`networks` is a list of authorized networks that are allowed to access the share having format\n\"network/mask\" CIDR notation. If empty, all networks are allowed."
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharingnfs_update",
"title": "sharingnfs_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "`path` local path to be exported."
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
],
"description": "`aliases` IGNORED, for now."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
],
"description": "`networks` is a list of authorized networks that are allowed to access the share having format\n\"network/mask\" CIDR notation. If empty, all networks are allowed."
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update NFS Share of `id`.\nCreate a NFS Share."
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharing_nfs_update_returns",
"title": "sharing_nfs_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled",
"id",
"locked"
]
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_NFS_WRITE, SHARING_WRITE |
Update NFS Share of |
sharing.smb.create |
---|
Arguments:
{
"type": "object",
"properties": {
"purpose": {
"_name_": "purpose",
"title": "purpose",
"default": "DEFAULT_SHARE",
"_required_": false,
"type": "string",
"enum": [
"NO_PRESET",
"DEFAULT_SHARE",
"TIMEMACHINE",
"ENHANCED_TIMEMACHINE",
"MULTI_PROTOCOL_NFS",
"PRIVATE_DATASETS",
"WORM_DROPBOX"
],
"description": "`purpose` applies common configuration presets depending on intended purpose."
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "`path` path to export over the SMB protocol."
},
"path_suffix": {
"_name_": "path_suffix",
"title": "path_suffix",
"default": "",
"_required_": false,
"type": "string"
},
"home": {
"type": "boolean",
"_name_": "home",
"title": "home",
"default": false,
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false,
"description": "`ro` when enabled, prohibits write access to the share."
},
"browsable": {
"type": "boolean",
"_name_": "browsable",
"title": "browsable",
"default": true,
"_required_": false
},
"timemachine": {
"type": "boolean",
"_name_": "timemachine",
"title": "timemachine",
"default": false,
"_required_": false,
"description": "`timemachine` when set, enables Time Machine backups for this share."
},
"timemachine_quota": {
"type": "integer",
"_name_": "timemachine_quota",
"title": "timemachine_quota",
"default": 0,
"_required_": false
},
"recyclebin": {
"type": "boolean",
"_name_": "recyclebin",
"title": "recyclebin",
"default": false,
"_required_": false
},
"guestok": {
"type": "boolean",
"_name_": "guestok",
"title": "guestok",
"default": false,
"_required_": false,
"description": "`guestok` when enabled, allows access to this share without a password."
},
"abe": {
"type": "boolean",
"_name_": "abe",
"title": "abe",
"default": false,
"_required_": false
},
"hostsallow": {
"_name_": "hostsallow",
"title": "hostsallow",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`hostsallow` is a list of hostnames / IP addresses which have access to this share.\n`hostsdeny` is a list of hostnames / IP addresses which are not allowed access to this share. If a handful\nof hostnames are to be only allowed access, `hostsdeny` can be passed \"ALL\" which means that it will deny\naccess to ALL hostnames except for the ones which have been listed in `hostsallow`."
},
"hostsdeny": {
"_name_": "hostsdeny",
"title": "hostsdeny",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`hostsdeny` is a list of hostnames / IP addresses which are not allowed access to this share. If a handful\nof hostnames are to be only allowed access, `hostsdeny` can be passed \"ALL\" which means that it will deny\naccess to ALL hostnames except for the ones which have been listed in `hostsallow`."
},
"aapl_name_mangling": {
"type": "boolean",
"_name_": "aapl_name_mangling",
"title": "aapl_name_mangling",
"default": false,
"_required_": false
},
"acl": {
"type": "boolean",
"_name_": "acl",
"title": "acl",
"default": true,
"_required_": false,
"description": "`acl` enables support for storing the SMB Security Descriptor as a Filesystem ACL."
},
"durablehandle": {
"type": "boolean",
"_name_": "durablehandle",
"title": "durablehandle",
"default": true,
"_required_": false
},
"shadowcopy": {
"type": "boolean",
"_name_": "shadowcopy",
"title": "shadowcopy",
"default": true,
"_required_": false,
"description": "`shadowcopy` enables support for the volume shadow copy service."
},
"streams": {
"type": "boolean",
"_name_": "streams",
"title": "streams",
"default": true,
"_required_": false,
"description": "`streams` enables support for storing alternate datastreams as filesystem extended attributes."
},
"fsrvp": {
"type": "boolean",
"_name_": "fsrvp",
"title": "fsrvp",
"default": false,
"_required_": false,
"description": "`fsrvp` enables support for the filesystem remote VSS protocol. This allows clients to create\nZFS snapshots through RPC."
},
"auxsmbconf": {
"_name_": "auxsmbconf",
"title": "auxsmbconf",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"afp": {
"type": "boolean",
"_name_": "afp",
"title": "afp",
"default": false,
"_required_": false
},
"audit": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"watch_list": {
"_name_": "watch_list",
"title": "watch_list",
"_required_": false,
"type": "array",
"items": []
},
"ignore_list": {
"_name_": "ignore_list",
"title": "ignore_list",
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "audit",
"title": "audit",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable",
"watch_list",
"ignore_list"
],
"description": "`audit` object contains configuration parameters related to SMB share auditing. It contains the\nfollowing keys: `enable`, `watch_list` and `ignore_list`. Enable is boolean and controls whether\naudit messages will be generated for the share. `watch_list` is a list of groups for which to\ngenerate audit messages (defaults to all groups). `ignore_list` is a list of groups to ignore\nwhen auditing. If conflict arises between watch_list and ignore_list (based on user group\nmembershipt), then watch_list will take precedence and ops will be audited.\nNOTE: auditing may not be enabled if SMB1 support is enabled for the server."
}
},
"additionalProperties": false,
"_name_": "sharingsmb_create",
"title": "sharingsmb_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"purpose",
"path",
"path_suffix",
"home",
"name",
"comment",
"ro",
"browsable",
"timemachine",
"timemachine_quota",
"recyclebin",
"guestok",
"abe",
"hostsallow",
"hostsdeny",
"aapl_name_mangling",
"acl",
"durablehandle",
"shadowcopy",
"streams",
"fsrvp",
"auxsmbconf",
"enabled",
"afp",
"audit"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sharing_smb_create_returns",
"title": "sharing_smb_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_SMB_WRITE, SHARING_WRITE |
Create a SMB Share.
|
sharing.smb.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_SMB_WRITE, SHARING_WRITE |
Delete SMB Share of |
sharing.smb.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sharing_smb_entry",
"title": "sharing_smb_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
Returns instance matching Please see |
sharing.smb.getacl |
---|
Arguments:
{
"type": "object",
"properties": {
"share_name": {
"_name_": "share_name",
"title": "share_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "smb_getacl",
"title": "smb_getacl",
"default": {},
"_required_": false,
"_attrs_order_": [
"share_name"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"share_name": {
"_name_": "share_name",
"title": "share_name",
"_required_": true,
"type": "string"
},
"share_acl": {
"_name_": "share_acl",
"title": "share_acl",
"default": [
{
"ae_who_sid": "S-1-1-0",
"ae_perm": "FULL",
"ae_type": "ALLOWED"
}
],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ae_who_sid": {
"_name_": "ae_who_sid",
"title": "ae_who_sid",
"default": null,
"_required_": false,
"type": "string"
},
"ae_who_id": {
"type": "object",
"properties": {
"id_type": {
"_name_": "id_type",
"title": "id_type",
"_required_": false,
"type": "string",
"enum": [
"USER",
"GROUP",
"BOTH"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ae_who_id",
"title": "ae_who_id",
"default": {},
"_required_": false,
"_attrs_order_": [
"id_type",
"id"
]
},
"ae_perm": {
"_name_": "ae_perm",
"title": "ae_perm",
"_required_": true,
"type": "string",
"enum": [
"FULL",
"CHANGE",
"READ"
]
},
"ae_type": {
"_name_": "ae_type",
"title": "ae_type",
"_required_": true,
"type": "string",
"enum": [
"ALLOWED",
"DENIED"
]
}
},
"additionalProperties": false,
"_name_": "aclentry",
"title": "aclentry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ae_who_sid",
"ae_who_id",
"ae_perm",
"ae_type"
]
}
]
}
},
"additionalProperties": false,
"_name_": "smb_share_acl",
"title": "smb_share_acl",
"default": {},
"_required_": false,
"_attrs_order_": [
"share_name",
"share_acl"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
- |
sharing.smb.presets |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
Retrieve pre-defined configuration sets for specific use-cases. These parameter combinations are often non-obvious, but beneficial in these scenarios. |
sharing.smb.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sharing_smb_entry",
"title": "sharing_smb_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sharing_smb_entry",
"title": "sharing_smb_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sharing_smb_entry",
"title": "sharing_smb_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
- |
sharing.smb.setacl |
---|
Arguments:
{
"type": "object",
"properties": {
"share_name": {
"_name_": "share_name",
"title": "share_name",
"_required_": true,
"type": "string",
"description": "Set an ACL on `share_name`. This only impacts access through the SMB protocol.\nEither ae_who_sid, ae_who_id must, ae_who_str be specified for each ACL entry in the\nshare_acl. If multiple are specified, preference is in the following order: SID,\nunix id, name.\n`share_name` the name of the share"
},
"share_acl": {
"_name_": "share_acl",
"title": "share_acl",
"default": [
{
"ae_who_sid": "S-1-1-0",
"ae_perm": "FULL",
"ae_type": "ALLOWED"
}
],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ae_who_sid": {
"_name_": "ae_who_sid",
"title": "ae_who_sid",
"default": null,
"_required_": false,
"type": "string"
},
"ae_who_id": {
"type": "object",
"properties": {
"id_type": {
"_name_": "id_type",
"title": "id_type",
"_required_": false,
"type": "string",
"enum": [
"USER",
"GROUP",
"BOTH"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ae_who_id",
"title": "ae_who_id",
"default": {},
"_required_": false,
"_attrs_order_": [
"id_type",
"id"
]
},
"ae_perm": {
"_name_": "ae_perm",
"title": "ae_perm",
"_required_": true,
"type": "string",
"enum": [
"FULL",
"CHANGE",
"READ"
]
},
"ae_type": {
"_name_": "ae_type",
"title": "ae_type",
"_required_": true,
"type": "string",
"enum": [
"ALLOWED",
"DENIED"
]
}
},
"additionalProperties": false,
"_name_": "aclentry",
"title": "aclentry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ae_who_sid",
"ae_who_id",
"ae_perm",
"ae_type"
]
}
],
"description": "`share_acl` a list of ACL entries (dictionaries) with the following keys:"
}
},
"additionalProperties": false,
"_name_": "smb_share_acl",
"title": "smb_share_acl",
"default": {},
"_required_": false,
"_attrs_order_": [
"share_name",
"share_acl"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"share_name": {
"_name_": "share_name",
"title": "share_name",
"_required_": true,
"type": "string",
"description": "Set an ACL on `share_name`. This only impacts access through the SMB protocol.\nEither ae_who_sid, ae_who_id must, ae_who_str be specified for each ACL entry in the\nshare_acl. If multiple are specified, preference is in the following order: SID,\nunix id, name.\n`share_name` the name of the share"
},
"share_acl": {
"_name_": "share_acl",
"title": "share_acl",
"default": [
{
"ae_who_sid": "S-1-1-0",
"ae_perm": "FULL",
"ae_type": "ALLOWED"
}
],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"ae_who_sid": {
"_name_": "ae_who_sid",
"title": "ae_who_sid",
"default": null,
"_required_": false,
"type": "string"
},
"ae_who_id": {
"type": "object",
"properties": {
"id_type": {
"_name_": "id_type",
"title": "id_type",
"_required_": false,
"type": "string",
"enum": [
"USER",
"GROUP",
"BOTH"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ae_who_id",
"title": "ae_who_id",
"default": {},
"_required_": false,
"_attrs_order_": [
"id_type",
"id"
]
},
"ae_perm": {
"_name_": "ae_perm",
"title": "ae_perm",
"_required_": true,
"type": "string",
"enum": [
"FULL",
"CHANGE",
"READ"
]
},
"ae_type": {
"_name_": "ae_type",
"title": "ae_type",
"_required_": true,
"type": "string",
"enum": [
"ALLOWED",
"DENIED"
]
}
},
"additionalProperties": false,
"_name_": "aclentry",
"title": "aclentry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ae_who_sid",
"ae_who_id",
"ae_perm",
"ae_type"
]
}
],
"description": "`share_acl` a list of ACL entries (dictionaries) with the following keys:"
}
},
"additionalProperties": false,
"_name_": "smb_share_acl",
"title": "smb_share_acl",
"default": {},
"_required_": false,
"_attrs_order_": [
"share_name",
"share_acl"
]
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_SMB_WRITE, SHARING_WRITE |
Set an ACL on
|
sharing.smb.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update SMB Share of `id`.\nCreate a SMB Share."
}
{
"type": "object",
"properties": {
"purpose": {
"_name_": "purpose",
"title": "purpose",
"default": "DEFAULT_SHARE",
"_required_": false,
"type": "string",
"enum": [
"NO_PRESET",
"DEFAULT_SHARE",
"TIMEMACHINE",
"ENHANCED_TIMEMACHINE",
"MULTI_PROTOCOL_NFS",
"PRIVATE_DATASETS",
"WORM_DROPBOX"
],
"description": "`purpose` applies common configuration presets depending on intended purpose."
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string",
"description": "`path` path to export over the SMB protocol."
},
"path_suffix": {
"_name_": "path_suffix",
"title": "path_suffix",
"default": "",
"_required_": false,
"type": "string"
},
"home": {
"type": "boolean",
"_name_": "home",
"title": "home",
"default": false,
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false,
"description": "`ro` when enabled, prohibits write access to the share."
},
"browsable": {
"type": "boolean",
"_name_": "browsable",
"title": "browsable",
"default": true,
"_required_": false
},
"timemachine": {
"type": "boolean",
"_name_": "timemachine",
"title": "timemachine",
"default": false,
"_required_": false,
"description": "`timemachine` when set, enables Time Machine backups for this share."
},
"timemachine_quota": {
"type": "integer",
"_name_": "timemachine_quota",
"title": "timemachine_quota",
"default": 0,
"_required_": false
},
"recyclebin": {
"type": "boolean",
"_name_": "recyclebin",
"title": "recyclebin",
"default": false,
"_required_": false
},
"guestok": {
"type": "boolean",
"_name_": "guestok",
"title": "guestok",
"default": false,
"_required_": false,
"description": "`guestok` when enabled, allows access to this share without a password."
},
"abe": {
"type": "boolean",
"_name_": "abe",
"title": "abe",
"default": false,
"_required_": false
},
"hostsallow": {
"_name_": "hostsallow",
"title": "hostsallow",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`hostsallow` is a list of hostnames / IP addresses which have access to this share.\n`hostsdeny` is a list of hostnames / IP addresses which are not allowed access to this share. If a handful\nof hostnames are to be only allowed access, `hostsdeny` can be passed \"ALL\" which means that it will deny\naccess to ALL hostnames except for the ones which have been listed in `hostsallow`."
},
"hostsdeny": {
"_name_": "hostsdeny",
"title": "hostsdeny",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`hostsdeny` is a list of hostnames / IP addresses which are not allowed access to this share. If a handful\nof hostnames are to be only allowed access, `hostsdeny` can be passed \"ALL\" which means that it will deny\naccess to ALL hostnames except for the ones which have been listed in `hostsallow`."
},
"aapl_name_mangling": {
"type": "boolean",
"_name_": "aapl_name_mangling",
"title": "aapl_name_mangling",
"default": false,
"_required_": false
},
"acl": {
"type": "boolean",
"_name_": "acl",
"title": "acl",
"default": true,
"_required_": false,
"description": "`acl` enables support for storing the SMB Security Descriptor as a Filesystem ACL."
},
"durablehandle": {
"type": "boolean",
"_name_": "durablehandle",
"title": "durablehandle",
"default": true,
"_required_": false
},
"shadowcopy": {
"type": "boolean",
"_name_": "shadowcopy",
"title": "shadowcopy",
"default": true,
"_required_": false,
"description": "`shadowcopy` enables support for the volume shadow copy service."
},
"streams": {
"type": "boolean",
"_name_": "streams",
"title": "streams",
"default": true,
"_required_": false,
"description": "`streams` enables support for storing alternate datastreams as filesystem extended attributes."
},
"fsrvp": {
"type": "boolean",
"_name_": "fsrvp",
"title": "fsrvp",
"default": false,
"_required_": false,
"description": "`fsrvp` enables support for the filesystem remote VSS protocol. This allows clients to create\nZFS snapshots through RPC."
},
"auxsmbconf": {
"_name_": "auxsmbconf",
"title": "auxsmbconf",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"afp": {
"type": "boolean",
"_name_": "afp",
"title": "afp",
"default": false,
"_required_": false
},
"audit": {
"type": "object",
"properties": {
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"watch_list": {
"_name_": "watch_list",
"title": "watch_list",
"_required_": false,
"type": "array",
"items": []
},
"ignore_list": {
"_name_": "ignore_list",
"title": "ignore_list",
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "audit",
"title": "audit",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable",
"watch_list",
"ignore_list"
],
"description": "`audit` object contains configuration parameters related to SMB share auditing. It contains the\nfollowing keys: `enable`, `watch_list` and `ignore_list`. Enable is boolean and controls whether\naudit messages will be generated for the share. `watch_list` is a list of groups for which to\ngenerate audit messages (defaults to all groups). `ignore_list` is a list of groups to ignore\nwhen auditing. If conflict arises between watch_list and ignore_list (based on user group\nmembershipt), then watch_list will take precedence and ops will be audited.\nNOTE: auditing may not be enabled if SMB1 support is enabled for the server."
}
},
"additionalProperties": false,
"_name_": "sharingsmb_update",
"title": "sharingsmb_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"purpose",
"path",
"path_suffix",
"home",
"name",
"comment",
"ro",
"browsable",
"timemachine",
"timemachine_quota",
"recyclebin",
"guestok",
"abe",
"hostsallow",
"hostsdeny",
"aapl_name_mangling",
"acl",
"durablehandle",
"shadowcopy",
"streams",
"fsrvp",
"auxsmbconf",
"enabled",
"afp",
"audit"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sharing_smb_update_returns",
"title": "sharing_smb_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_SMB_WRITE, SHARING_WRITE |
Update SMB Share of |
smart.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"interval": {
"type": "integer",
"_name_": "interval",
"title": "interval",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"powermode": {
"_name_": "powermode",
"title": "powermode",
"_required_": true,
"type": "string",
"enum": [
"NEVER",
"SLEEP",
"STANDBY",
"IDLE"
]
},
"difference": {
"type": "integer",
"_name_": "difference",
"title": "difference",
"_required_": true
},
"informational": {
"type": "integer",
"_name_": "informational",
"title": "informational",
"_required_": true
},
"critical": {
"type": "integer",
"_name_": "critical",
"title": "critical",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "smart_entry",
"title": "smart_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"interval",
"id",
"powermode",
"difference",
"informational",
"critical"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
smart.update |
---|
Arguments:
{
"type": "object",
"properties": {
"interval": {
"type": "integer",
"_name_": "interval",
"title": "interval",
"_required_": true,
"description": "`interval` is an integer value in minutes which defines how often smartd activates to check if any tests\nare configured to run."
},
"powermode": {
"_name_": "powermode",
"title": "powermode",
"_required_": true,
"type": "string",
"enum": [
"NEVER",
"SLEEP",
"STANDBY",
"IDLE"
]
},
"difference": {
"type": "integer",
"_name_": "difference",
"title": "difference",
"_required_": true
},
"informational": {
"type": "integer",
"_name_": "informational",
"title": "informational",
"_required_": true
},
"critical": {
"type": "integer",
"_name_": "critical",
"title": "critical",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "smart_update",
"title": "smart_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"interval",
"powermode",
"difference",
"informational",
"critical"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"interval": {
"type": "integer",
"_name_": "interval",
"title": "interval",
"_required_": true,
"description": "`interval` is an integer value in minutes which defines how often smartd activates to check if any tests\nare configured to run."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"powermode": {
"_name_": "powermode",
"title": "powermode",
"_required_": true,
"type": "string",
"enum": [
"NEVER",
"SLEEP",
"STANDBY",
"IDLE"
]
},
"difference": {
"type": "integer",
"_name_": "difference",
"title": "difference",
"_required_": true
},
"informational": {
"type": "integer",
"_name_": "informational",
"title": "informational",
"_required_": true
},
"critical": {
"type": "integer",
"_name_": "critical",
"title": "critical",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "smart_update_returns",
"title": "smart_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"interval",
"id",
"powermode",
"difference",
"informational",
"critical"
]
}
|
Update SMART Service Configuration.
|
smart.test.abort |
---|
Arguments:
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
|
Abort non-captive S.M.A.R.T. tests for disk. |
smart.test.create |
---|
Arguments:
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false,
"description": "`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
],
"description": "`disks` is a list of valid disks which should be monitored in this task.\n`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
],
"description": "`type` is specified to represent the type of SMART test to be executed."
}
},
"additionalProperties": false,
"_name_": "smart_task_create",
"title": "smart_task_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false,
"description": "`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
],
"description": "`disks` is a list of valid disks which should be monitored in this task.\n`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
],
"description": "`type` is specified to represent the type of SMART test to be executed."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "smart_test_create_returns",
"title": "smart_test_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type",
"id"
]
}
|
Create a SMART Test Task.
|
Create a SMART Test Task which executes after every 30 minutes.
|
smart.test.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete SMART Test Task of |
smart.test.disk_choices |
---|
Arguments:
{
"type": "boolean",
"_name_": "full_disk",
"title": "full_disk",
"default": false,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns disk choices for S.M.A.R.T. test.
|
smart.test.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "smart_task_entry",
"title": "smart_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
smart.test.manual_test |
---|
Arguments:
{
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "BACKGROUND",
"_required_": false,
"type": "string",
"enum": [
"FOREGROUND",
"BACKGROUND"
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
]
}
},
"additionalProperties": false,
"_name_": "disk_run",
"title": "disk_run",
"default": {},
"_required_": false,
"_attrs_order_": [
"identifier",
"mode",
"type"
]
}
],
"description": "Run manual SMART tests for `disks`."
}
|
Return Arguments:
{
"_name_": "smart_manual_test",
"title": "smart_manual_test",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"disk": {
"_name_": "disk",
"title": "disk",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"error": {
"_name_": "error",
"title": "error",
"_required_": true,
"type": [
"string",
"null"
]
},
"expected_result_time": {
"_name_": "expected_result_time",
"title": "expected_result_time",
"_required_": false,
"type": "string"
},
"job": {
"type": "integer",
"_name_": "job",
"title": "job",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "smart_manual_test_disk_response",
"title": "smart_manual_test_disk_response",
"default": {},
"_required_": false,
"_attrs_order_": [
"disk",
"identifier",
"error",
"expected_result_time",
"job"
]
}
]
}
|
Run manual SMART tests for
|
smart.test.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "smart_task_entry",
"title": "smart_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "smart_task_entry",
"title": "smart_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "smart_task_entry",
"title": "smart_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
smart.test.query_for_disk |
---|
Arguments:
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Query S.M.A.R.T. tests for the specified disk. |
smart.test.results |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"disk": {
"_name_": "disk",
"title": "disk",
"_required_": true,
"type": "string"
},
"tests": {
"_name_": "tests",
"title": "tests",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"num": {
"type": "integer",
"_name_": "num",
"title": "num",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"status_verbose": {
"_name_": "status_verbose",
"title": "status_verbose",
"_required_": true,
"type": "string"
},
"segment_number": {
"type": [
"integer",
"null"
],
"_name_": "segment_number",
"title": "segment_number",
"_required_": false
},
"remaining": {
"type": "float",
"_name_": "remaining",
"title": "remaining",
"_required_": false
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": true
},
"lba_of_first_error": {
"_name_": "lba_of_first_error",
"title": "lba_of_first_error",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "test_result",
"title": "test_result",
"default": {},
"_required_": false,
"_attrs_order_": [
"num",
"description",
"status",
"status_verbose",
"segment_number",
"remaining",
"lifetime",
"lba_of_first_error"
]
}
]
},
"current_test": {
"type": "object",
"properties": {
"progress": {
"type": "integer",
"_name_": "progress",
"title": "progress",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "current_test",
"title": "current_test",
"default": {},
"_required_": false,
"_attrs_order_": [
"progress"
]
}
},
"additionalProperties": true,
"_name_": "disk_smart_test_result",
"title": "disk_smart_test_result",
"default": {},
"_required_": false,
"_attrs_order_": [
"disk",
"tests",
"current_test"
]
},
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"disk": {
"_name_": "disk",
"title": "disk",
"_required_": true,
"type": "string"
},
"tests": {
"_name_": "tests",
"title": "tests",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"num": {
"type": "integer",
"_name_": "num",
"title": "num",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"status_verbose": {
"_name_": "status_verbose",
"title": "status_verbose",
"_required_": true,
"type": "string"
},
"segment_number": {
"type": [
"integer",
"null"
],
"_name_": "segment_number",
"title": "segment_number",
"_required_": false
},
"remaining": {
"type": "float",
"_name_": "remaining",
"title": "remaining",
"_required_": false
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": true
},
"lba_of_first_error": {
"_name_": "lba_of_first_error",
"title": "lba_of_first_error",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "test_result",
"title": "test_result",
"default": {},
"_required_": false,
"_attrs_order_": [
"num",
"description",
"status",
"status_verbose",
"segment_number",
"remaining",
"lifetime",
"lba_of_first_error"
]
}
]
},
"current_test": {
"type": "object",
"properties": {
"progress": {
"type": "integer",
"_name_": "progress",
"title": "progress",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "current_test",
"title": "current_test",
"default": {},
"_required_": false,
"_attrs_order_": [
"progress"
]
}
},
"additionalProperties": true,
"_name_": "disk_smart_test_result",
"title": "disk_smart_test_result",
"default": {},
"_required_": false,
"_attrs_order_": [
"disk",
"tests",
"current_test"
]
}
]
}
],
"nullable": false,
"_name_": "filterable_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPORTING_READ, REPORTING_WRITE, SHARING_ADMIN |
Get disk(s) S.M.A.R.T. test(s) results.
|
Get all disks tests results
Get specific disk test results
|
smart.test.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update SMART Test Task of `id`.\nCreate a SMART Test Task."
}
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false,
"description": "`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
],
"description": "`disks` is a list of valid disks which should be monitored in this task.\n`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
],
"description": "`type` is specified to represent the type of SMART test to be executed."
}
},
"additionalProperties": false,
"_name_": "smart_test_update",
"title": "smart_test_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false,
"description": "`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
],
"description": "`disks` is a list of valid disks which should be monitored in this task.\n`all_disks` when enabled sets the task to cover all disks in which case `disks` is not required."
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
],
"description": "`type` is specified to represent the type of SMART test to be executed."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update SMART Test Task of `id`.\nCreate a SMART Test Task."
}
},
"additionalProperties": false,
"_name_": "smart_test_update_returns",
"title": "smart_test_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type",
"id"
]
}
|
Update SMART Test Task of |
smb.bindip_choices |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
List of valid choices for IP addresses to which to bind the SMB service. Addresses assigned by DHCP are excluded from the results. |
smb.client_count |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
Return currently connected clients count. |
smb.config |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "smb_entry",
"title": "smb_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
- |
smb.domain_choices |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
List of domains visible to winbindd. Returns empty list if winbindd is stopped. |
smb.status |
---|
Arguments:
{
"_name_": "info_level",
"title": "info_level",
"default": "ALL",
"_required_": false,
"type": "string",
"enum": [
"AUTH_LOG",
"ALL",
"SESSIONS",
"SHARES",
"LOCKS",
"BYTERANGE",
"NOTIFICATIONS"
],
"description": "`info_level` type of information requests. Defaults to ALL."
}
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
{
"type": "object",
"properties": {
"verbose": {
"type": "boolean",
"_name_": "verbose",
"title": "verbose",
"default": true,
"_required_": false,
"description": "`status_options` additional options to filter query results. Supported\nvalues are as follows: `verbose` gives more verbose status output"
},
"fast": {
"type": "boolean",
"_name_": "fast",
"title": "fast",
"default": false,
"_required_": false,
"description": "`fast` causes smbstatus to not check if the status data is valid by\nchecking if the processes that the status data refer to all still\nexist. This speeds up execution on busy systems and clusters but\nmight display stale data of processes that died without cleaning up\nproperly. `restrict_user` specifies the limits results to the specified\nuser."
},
"restrict_user": {
"_name_": "restrict_user",
"title": "restrict_user",
"default": "",
"_required_": false,
"type": "string",
"description": "`fast` causes smbstatus to not check if the status data is valid by\nchecking if the processes that the status data refer to all still\nexist. This speeds up execution on busy systems and clusters but\nmight display stale data of processes that died without cleaning up\nproperly. `restrict_user` specifies the limits results to the specified\nuser."
},
"restrict_session": {
"_name_": "restrict_session",
"title": "restrict_session",
"default": "",
"_required_": false,
"type": "string"
},
"resolve_uids": {
"type": "boolean",
"_name_": "resolve_uids",
"title": "resolve_uids",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "status_options",
"title": "status_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"verbose",
"fast",
"restrict_user",
"restrict_session",
"resolve_uids"
],
"description": "`status_options` additional options to filter query results. Supported\nvalues are as follows: `verbose` gives more verbose status output"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_SMB_WRITE, SHARING_WRITE |
Returns SMB server status (sessions, open files, locks, notifications).
This API endpoint also supports a legacy |
smb.unixcharset_choices |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SHARING_READ, SHARING_SMB_READ, SHARING_SMB_WRITE, SHARING_WRITE |
- |
smb.update |
---|
Arguments:
{
"type": "object",
"properties": {
"netbiosname": {
"_name_": "netbiosname",
"title": "netbiosname",
"_required_": false,
"type": "string",
"description": "`netbiosname` defaults to the original hostname of the system.\n`workgroup` specifies the NetBIOS workgroup to which the TrueNAS server belongs. This will be\nautomatically set to the correct value during the process of joining an AD domain.\nNOTE: `workgroup` and `netbiosname` should have different values."
},
"netbiosname_b": {
"_name_": "netbiosname_b",
"title": "netbiosname_b",
"_required_": false,
"type": "string"
},
"netbiosalias": {
"_name_": "netbiosalias",
"title": "netbiosalias",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "netbios_alias",
"title": "netbios_alias",
"_required_": false,
"type": "string"
}
],
"description": "`netbiosalias` a list of netbios aliases. If Server is joined to an AD domain, additional Kerberos\nService Principal Names will be generated for these aliases."
},
"workgroup": {
"_name_": "workgroup",
"title": "workgroup",
"_required_": false,
"type": "string",
"description": "`workgroup` specifies the NetBIOS workgroup to which the TrueNAS server belongs. This will be\nautomatically set to the correct value during the process of joining an AD domain.\nNOTE: `workgroup` and `netbiosname` should have different values."
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"enable_smb1": {
"type": "boolean",
"_name_": "enable_smb1",
"title": "enable_smb1",
"_required_": false,
"description": "`enable_smb1` allows legacy SMB clients to connect to the server when enabled."
},
"unixcharset": {
"_name_": "unixcharset",
"title": "unixcharset",
"_required_": false,
"type": "string"
},
"loglevel": {
"_name_": "loglevel",
"title": "loglevel",
"_required_": false,
"type": "string",
"enum": [
"NONE",
"MINIMUM",
"NORMAL",
"FULL",
"DEBUG"
]
},
"syslog": {
"type": "boolean",
"_name_": "syslog",
"title": "syslog",
"_required_": false
},
"aapl_extensions": {
"type": "boolean",
"_name_": "aapl_extensions",
"title": "aapl_extensions",
"_required_": false,
"description": "`aapl_extensions` enables support for SMB2 protocol extensions for MacOS clients. This is not a\nrequirement for MacOS support, but is currently a requirement for time machine support."
},
"localmaster": {
"type": "boolean",
"_name_": "localmaster",
"title": "localmaster",
"_required_": false,
"description": "`localmaster` when set, determines if the system participates in a browser election."
},
"guest": {
"_name_": "guest",
"title": "guest",
"_required_": false,
"type": "string",
"description": "`guest` attribute is specified to select the account to be used for guest access. It defaults to \"nobody\"."
},
"admin_group": {
"_name_": "admin_group",
"title": "admin_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "The group specified as the SMB `admin_group` will be automatically added as a foreign group member\nof S-1-5-32-544 (builtin\\admins). This will afford the group all privileges granted to a local admin.\nAny SMB group may be selected (including AD groups)."
},
"filemask": {
"_name_": "filemask",
"title": "filemask",
"_required_": false,
"type": "string"
},
"dirmask": {
"_name_": "dirmask",
"title": "dirmask",
"_required_": false,
"type": "string"
},
"ntlmv1_auth": {
"type": "boolean",
"_name_": "ntlmv1_auth",
"title": "ntlmv1_auth",
"_required_": false,
"description": "`ntlmv1_auth` enables a legacy and insecure authentication method, which may be required for legacy or\npoorly-implemented SMB clients."
},
"multichannel": {
"type": "boolean",
"_name_": "multichannel",
"title": "multichannel",
"default": false,
"_required_": false
},
"encryption": {
"_name_": "encryption",
"title": "encryption",
"_required_": false,
"type": "string",
"enum": [
"DEFAULT",
"NEGOTIATE",
"DESIRED",
"REQUIRED"
],
"description": "`encryption` set global server behavior with regard to SMB encrpytion. Options are DEFAULT (which\nfollows the upstream defaults -- currently identical to NEGOTIATE), NEGOTIATE encrypts SMB transport\nonly if requested by the SMB client, DESIRED encrypts SMB transport if supported by the SMB client,\nREQUIRED only allows encrypted transport to the SMB server. Mandatory SMB encryption is not\ncompatible with SMB1 server support in TrueNAS."
},
"bindip": {
"_name_": "bindip",
"title": "bindip",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "ip",
"title": "ip",
"_required_": false,
"type": "string"
}
]
},
"smb_options": {
"_name_": "smb_options",
"title": "smb_options",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "smb_update",
"title": "smb_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"netbiosname",
"netbiosname_b",
"netbiosalias",
"workgroup",
"description",
"enable_smb1",
"unixcharset",
"loglevel",
"syslog",
"aapl_extensions",
"localmaster",
"guest",
"admin_group",
"filemask",
"dirmask",
"ntlmv1_auth",
"multichannel",
"encryption",
"bindip",
"smb_options"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "smb_update_returns",
"title": "smb_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: SHARING_ADMIN, SHARING_SMB_WRITE, SHARING_WRITE |
Update SMB Service Configuration.
The group specified as the SMB
|
snmp.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"contact": {
"_name_": "contact",
"title": "contact",
"_required_": true,
"type": "string"
},
"traps": {
"type": "boolean",
"_name_": "traps",
"title": "traps",
"_required_": true
},
"v3": {
"type": "boolean",
"_name_": "v3",
"title": "v3",
"_required_": true
},
"community": {
"_name_": "community",
"title": "community",
"default": "public",
"_required_": true,
"type": "string"
},
"v3_username": {
"_name_": "v3_username",
"title": "v3_username",
"_required_": true,
"type": "string"
},
"v3_authtype": {
"_name_": "v3_authtype",
"title": "v3_authtype",
"_required_": true,
"type": "string",
"enum": [
"",
"MD5",
"SHA"
]
},
"v3_password": {
"_name_": "v3_password",
"title": "v3_password",
"_required_": true,
"type": "string"
},
"v3_privproto": {
"_name_": "v3_privproto",
"title": "v3_privproto",
"_required_": true,
"type": [
"string",
"null"
],
"enum": [
null,
"AES",
"DES"
]
},
"v3_privpassphrase": {
"_name_": "v3_privpassphrase",
"title": "v3_privpassphrase",
"_required_": true,
"type": [
"string",
"null"
]
},
"loglevel": {
"type": "integer",
"_name_": "loglevel",
"title": "loglevel",
"_required_": true
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"zilstat": {
"type": "boolean",
"_name_": "zilstat",
"title": "zilstat",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "snmp_entry",
"title": "snmp_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"location",
"contact",
"traps",
"v3",
"community",
"v3_username",
"v3_authtype",
"v3_password",
"v3_privproto",
"v3_privpassphrase",
"loglevel",
"options",
"zilstat",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
snmp.update |
---|
Arguments:
{
"type": "object",
"properties": {
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"contact": {
"_name_": "contact",
"title": "contact",
"_required_": true,
"type": "string"
},
"traps": {
"type": "boolean",
"_name_": "traps",
"title": "traps",
"_required_": true
},
"v3": {
"type": "boolean",
"_name_": "v3",
"title": "v3",
"_required_": true
},
"community": {
"_name_": "community",
"title": "community",
"default": "public",
"_required_": true,
"type": "string"
},
"v3_username": {
"_name_": "v3_username",
"title": "v3_username",
"_required_": true,
"type": "string"
},
"v3_authtype": {
"_name_": "v3_authtype",
"title": "v3_authtype",
"_required_": true,
"type": "string",
"enum": [
"",
"MD5",
"SHA"
]
},
"v3_password": {
"_name_": "v3_password",
"title": "v3_password",
"_required_": true,
"type": "string"
},
"v3_privproto": {
"_name_": "v3_privproto",
"title": "v3_privproto",
"_required_": true,
"type": [
"string",
"null"
],
"enum": [
null,
"AES",
"DES"
]
},
"v3_privpassphrase": {
"_name_": "v3_privpassphrase",
"title": "v3_privpassphrase",
"_required_": true,
"type": [
"string",
"null"
]
},
"loglevel": {
"type": "integer",
"_name_": "loglevel",
"title": "loglevel",
"_required_": true
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"zilstat": {
"type": "boolean",
"_name_": "zilstat",
"title": "zilstat",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "snmp_update",
"title": "snmp_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"location",
"contact",
"traps",
"v3",
"community",
"v3_username",
"v3_authtype",
"v3_password",
"v3_privproto",
"v3_privpassphrase",
"loglevel",
"options",
"zilstat"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"location": {
"_name_": "location",
"title": "location",
"_required_": true,
"type": "string"
},
"contact": {
"_name_": "contact",
"title": "contact",
"_required_": true,
"type": "string"
},
"traps": {
"type": "boolean",
"_name_": "traps",
"title": "traps",
"_required_": true
},
"v3": {
"type": "boolean",
"_name_": "v3",
"title": "v3",
"_required_": true
},
"community": {
"_name_": "community",
"title": "community",
"default": "public",
"_required_": true,
"type": "string"
},
"v3_username": {
"_name_": "v3_username",
"title": "v3_username",
"_required_": true,
"type": "string"
},
"v3_authtype": {
"_name_": "v3_authtype",
"title": "v3_authtype",
"_required_": true,
"type": "string",
"enum": [
"",
"MD5",
"SHA"
]
},
"v3_password": {
"_name_": "v3_password",
"title": "v3_password",
"_required_": true,
"type": "string"
},
"v3_privproto": {
"_name_": "v3_privproto",
"title": "v3_privproto",
"_required_": true,
"type": [
"string",
"null"
],
"enum": [
null,
"AES",
"DES"
]
},
"v3_privpassphrase": {
"_name_": "v3_privpassphrase",
"title": "v3_privpassphrase",
"_required_": true,
"type": [
"string",
"null"
]
},
"loglevel": {
"type": "integer",
"_name_": "loglevel",
"title": "loglevel",
"_required_": true
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"zilstat": {
"type": "boolean",
"_name_": "zilstat",
"title": "zilstat",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "snmp_update_returns",
"title": "snmp_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"location",
"contact",
"traps",
"v3",
"community",
"v3_username",
"v3_authtype",
"v3_password",
"v3_privproto",
"v3_privpassphrase",
"loglevel",
"options",
"zilstat",
"id"
]
}
|
Update SNMP Service Configuration. --- Rules --- Enabling v3: requires v3_username, v3_authtype and v3_password Disabling v3: By itself will retain the v3 user settings and config in the 'private' config, but remove the entry in the public config to block v3 access by that user. Disabling v3 and clearing the v3_username: This will do the actions described in 'Disabling v3' and take the extra step to remove the user from the 'private' config. The 'v3_*' settings are valid and enforced only when 'v3' is enabled |
ssh.bindiface_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_bind_interfaces_choices",
"title": "ssh_bind_interfaces_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Available choices for the bindiface attribute of SSH service. |
ssh.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"bindiface": {
"_name_": "bindiface",
"title": "bindiface",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "iface",
"title": "iface",
"_required_": false,
"type": "string"
}
]
},
"tcpport": {
"type": "integer",
"_name_": "tcpport",
"title": "tcpport",
"_required_": true
},
"password_login_groups": {
"_name_": "password_login_groups",
"title": "password_login_groups",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
}
]
},
"passwordauth": {
"type": "boolean",
"_name_": "passwordauth",
"title": "passwordauth",
"_required_": true
},
"kerberosauth": {
"type": "boolean",
"_name_": "kerberosauth",
"title": "kerberosauth",
"_required_": true
},
"tcpfwd": {
"type": "boolean",
"_name_": "tcpfwd",
"title": "tcpfwd",
"_required_": true
},
"compression": {
"type": "boolean",
"_name_": "compression",
"title": "compression",
"_required_": true
},
"sftp_log_level": {
"_name_": "sftp_log_level",
"title": "sftp_log_level",
"_required_": true,
"type": "string",
"enum": [
"",
"QUIET",
"FATAL",
"ERROR",
"INFO",
"VERBOSE",
"DEBUG",
"DEBUG2",
"DEBUG3"
]
},
"sftp_log_facility": {
"_name_": "sftp_log_facility",
"title": "sftp_log_facility",
"_required_": true,
"type": "string",
"enum": [
"",
"DAEMON",
"USER",
"AUTH",
"LOCAL0",
"LOCAL1",
"LOCAL2",
"LOCAL3",
"LOCAL4",
"LOCAL5",
"LOCAL6",
"LOCAL7"
]
},
"weak_ciphers": {
"_name_": "weak_ciphers",
"title": "weak_ciphers",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "cipher",
"title": "cipher",
"_required_": false,
"type": "string",
"enum": [
"AES128-CBC",
"NONE"
]
}
]
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": true,
"type": "string"
},
"host_dsa_key": {
"_name_": "host_dsa_key",
"title": "host_dsa_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_dsa_key_pub": {
"_name_": "host_dsa_key_pub",
"title": "host_dsa_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_dsa_key_cert_pub": {
"_name_": "host_dsa_key_cert_pub",
"title": "host_dsa_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ecdsa_key": {
"_name_": "host_ecdsa_key",
"title": "host_ecdsa_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ecdsa_key_pub": {
"_name_": "host_ecdsa_key_pub",
"title": "host_ecdsa_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ecdsa_key_cert_pub": {
"_name_": "host_ecdsa_key_cert_pub",
"title": "host_ecdsa_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ed25519_key": {
"_name_": "host_ed25519_key",
"title": "host_ed25519_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ed25519_key_pub": {
"_name_": "host_ed25519_key_pub",
"title": "host_ed25519_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ed25519_key_cert_pub": {
"_name_": "host_ed25519_key_cert_pub",
"title": "host_ed25519_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_key": {
"_name_": "host_key",
"title": "host_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_key_pub": {
"_name_": "host_key_pub",
"title": "host_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_rsa_key": {
"_name_": "host_rsa_key",
"title": "host_rsa_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_rsa_key_pub": {
"_name_": "host_rsa_key_pub",
"title": "host_rsa_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_rsa_key_cert_pub": {
"_name_": "host_rsa_key_cert_pub",
"title": "host_rsa_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "ssh_entry",
"title": "ssh_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"bindiface",
"tcpport",
"password_login_groups",
"passwordauth",
"kerberosauth",
"tcpfwd",
"compression",
"sftp_log_level",
"sftp_log_facility",
"weak_ciphers",
"options",
"privatekey",
"host_dsa_key",
"host_dsa_key_pub",
"host_dsa_key_cert_pub",
"host_ecdsa_key",
"host_ecdsa_key_pub",
"host_ecdsa_key_cert_pub",
"host_ed25519_key",
"host_ed25519_key_pub",
"host_ed25519_key_cert_pub",
"host_key",
"host_key_pub",
"host_rsa_key",
"host_rsa_key_pub",
"host_rsa_key_cert_pub",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
ssh.update |
---|
Arguments:
{
"type": "object",
"properties": {
"bindiface": {
"_name_": "bindiface",
"title": "bindiface",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "iface",
"title": "iface",
"_required_": false,
"type": "string"
}
],
"description": "If `bindiface` is empty it will listen for all available addresses."
},
"tcpport": {
"type": "integer",
"_name_": "tcpport",
"title": "tcpport",
"_required_": true
},
"password_login_groups": {
"_name_": "password_login_groups",
"title": "password_login_groups",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
}
]
},
"passwordauth": {
"type": "boolean",
"_name_": "passwordauth",
"title": "passwordauth",
"_required_": true
},
"kerberosauth": {
"type": "boolean",
"_name_": "kerberosauth",
"title": "kerberosauth",
"_required_": true
},
"tcpfwd": {
"type": "boolean",
"_name_": "tcpfwd",
"title": "tcpfwd",
"_required_": true
},
"compression": {
"type": "boolean",
"_name_": "compression",
"title": "compression",
"_required_": true
},
"sftp_log_level": {
"_name_": "sftp_log_level",
"title": "sftp_log_level",
"_required_": true,
"type": "string",
"enum": [
"",
"QUIET",
"FATAL",
"ERROR",
"INFO",
"VERBOSE",
"DEBUG",
"DEBUG2",
"DEBUG3"
]
},
"sftp_log_facility": {
"_name_": "sftp_log_facility",
"title": "sftp_log_facility",
"_required_": true,
"type": "string",
"enum": [
"",
"DAEMON",
"USER",
"AUTH",
"LOCAL0",
"LOCAL1",
"LOCAL2",
"LOCAL3",
"LOCAL4",
"LOCAL5",
"LOCAL6",
"LOCAL7"
]
},
"weak_ciphers": {
"_name_": "weak_ciphers",
"title": "weak_ciphers",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "cipher",
"title": "cipher",
"_required_": false,
"type": "string",
"enum": [
"AES128-CBC",
"NONE"
]
}
]
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ssh_update",
"title": "ssh_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"bindiface",
"tcpport",
"password_login_groups",
"passwordauth",
"kerberosauth",
"tcpfwd",
"compression",
"sftp_log_level",
"sftp_log_facility",
"weak_ciphers",
"options"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"bindiface": {
"_name_": "bindiface",
"title": "bindiface",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "iface",
"title": "iface",
"_required_": false,
"type": "string"
}
],
"description": "If `bindiface` is empty it will listen for all available addresses."
},
"tcpport": {
"type": "integer",
"_name_": "tcpport",
"title": "tcpport",
"_required_": true
},
"password_login_groups": {
"_name_": "password_login_groups",
"title": "password_login_groups",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
}
]
},
"passwordauth": {
"type": "boolean",
"_name_": "passwordauth",
"title": "passwordauth",
"_required_": true
},
"kerberosauth": {
"type": "boolean",
"_name_": "kerberosauth",
"title": "kerberosauth",
"_required_": true
},
"tcpfwd": {
"type": "boolean",
"_name_": "tcpfwd",
"title": "tcpfwd",
"_required_": true
},
"compression": {
"type": "boolean",
"_name_": "compression",
"title": "compression",
"_required_": true
},
"sftp_log_level": {
"_name_": "sftp_log_level",
"title": "sftp_log_level",
"_required_": true,
"type": "string",
"enum": [
"",
"QUIET",
"FATAL",
"ERROR",
"INFO",
"VERBOSE",
"DEBUG",
"DEBUG2",
"DEBUG3"
]
},
"sftp_log_facility": {
"_name_": "sftp_log_facility",
"title": "sftp_log_facility",
"_required_": true,
"type": "string",
"enum": [
"",
"DAEMON",
"USER",
"AUTH",
"LOCAL0",
"LOCAL1",
"LOCAL2",
"LOCAL3",
"LOCAL4",
"LOCAL5",
"LOCAL6",
"LOCAL7"
]
},
"weak_ciphers": {
"_name_": "weak_ciphers",
"title": "weak_ciphers",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "cipher",
"title": "cipher",
"_required_": false,
"type": "string",
"enum": [
"AES128-CBC",
"NONE"
]
}
]
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": true,
"type": "string"
},
"host_dsa_key": {
"_name_": "host_dsa_key",
"title": "host_dsa_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_dsa_key_pub": {
"_name_": "host_dsa_key_pub",
"title": "host_dsa_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_dsa_key_cert_pub": {
"_name_": "host_dsa_key_cert_pub",
"title": "host_dsa_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ecdsa_key": {
"_name_": "host_ecdsa_key",
"title": "host_ecdsa_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ecdsa_key_pub": {
"_name_": "host_ecdsa_key_pub",
"title": "host_ecdsa_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ecdsa_key_cert_pub": {
"_name_": "host_ecdsa_key_cert_pub",
"title": "host_ecdsa_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ed25519_key": {
"_name_": "host_ed25519_key",
"title": "host_ed25519_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ed25519_key_pub": {
"_name_": "host_ed25519_key_pub",
"title": "host_ed25519_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_ed25519_key_cert_pub": {
"_name_": "host_ed25519_key_cert_pub",
"title": "host_ed25519_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_key": {
"_name_": "host_key",
"title": "host_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_key_pub": {
"_name_": "host_key_pub",
"title": "host_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_rsa_key": {
"_name_": "host_rsa_key",
"title": "host_rsa_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_rsa_key_pub": {
"_name_": "host_rsa_key_pub",
"title": "host_rsa_key_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"host_rsa_key_cert_pub": {
"_name_": "host_rsa_key_cert_pub",
"title": "host_rsa_key_cert_pub",
"_required_": true,
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "ssh_update_returns",
"title": "ssh_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"bindiface",
"tcpport",
"password_login_groups",
"passwordauth",
"kerberosauth",
"tcpfwd",
"compression",
"sftp_log_level",
"sftp_log_facility",
"weak_ciphers",
"options",
"privatekey",
"host_dsa_key",
"host_dsa_key_pub",
"host_dsa_key_cert_pub",
"host_ecdsa_key",
"host_ecdsa_key_pub",
"host_ecdsa_key_cert_pub",
"host_ed25519_key",
"host_ed25519_key_pub",
"host_ed25519_key_cert_pub",
"host_key",
"host_key_pub",
"host_rsa_key",
"host_rsa_key_pub",
"host_rsa_key_cert_pub",
"id"
]
}
|
Update settings of SSH daemon service. If |
Make sshd listen only to igb0 interface.
|
staticroute.create |
---|
Arguments:
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "staticroute_create",
"title": "staticroute_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "staticroute_create_returns",
"title": "staticroute_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description",
"id"
]
}
|
Create a Static Route. Address families of
|
staticroute.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete Static Route of |
staticroute.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string"
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "staticroute_entry",
"title": "staticroute_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
staticroute.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string"
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "staticroute_entry",
"title": "staticroute_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string"
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "staticroute_entry",
"title": "staticroute_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string"
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "staticroute_entry",
"title": "staticroute_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
staticroute.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Static Route of `id`.\nCreate a Static Route."
}
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "staticroute_update",
"title": "staticroute_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string",
"description": "Address families of `gateway` and `destination` should match when creating a static route."
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update Static Route of `id`.\nCreate a Static Route."
}
},
"additionalProperties": false,
"_name_": "staticroute_update_returns",
"title": "staticroute_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description",
"id"
]
}
|
Update Static Route of |
support.attach_ticket |
---|
Arguments:
{
"type": "object",
"properties": {
"ticket": {
"type": "integer",
"_name_": "ticket",
"title": "ticket",
"_required_": true
},
"filename": {
"_name_": "filename",
"title": "filename",
"_required_": true,
"type": "string"
},
"token": {
"_name_": "token",
"title": "token",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attach_ticket",
"title": "attach_ticket",
"default": {},
"_required_": false,
"_attrs_order_": [
"ticket",
"filename",
"token"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_WRITE |
Method to attach a file to a existing ticket. |
support.attach_ticket_max_size |
---|
Return Arguments:
{
"type": "integer",
"_name_": "attach_ticket_max_size",
"title": "attach_ticket_max_size",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_READ, SUPPORT_WRITE |
Returns maximum uploaded file size for |
support.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": [
"boolean",
"null"
],
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"email": {
"_name_": "email",
"title": "email",
"_required_": true,
"type": "string"
},
"phone": {
"_name_": "phone",
"title": "phone",
"_required_": true,
"type": "string"
},
"secondary_name": {
"_name_": "secondary_name",
"title": "secondary_name",
"_required_": true,
"type": "string"
},
"secondary_title": {
"_name_": "secondary_title",
"title": "secondary_title",
"_required_": true,
"type": "string"
},
"secondary_email": {
"_name_": "secondary_email",
"title": "secondary_email",
"_required_": true,
"type": "string"
},
"secondary_phone": {
"_name_": "secondary_phone",
"title": "secondary_phone",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "support_entry",
"title": "support_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"name",
"title",
"email",
"phone",
"secondary_name",
"secondary_title",
"secondary_email",
"secondary_phone",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_READ, SUPPORT_WRITE |
- |
support.fetch_categories |
---|
Arguments:
{
"_name_": "token",
"title": "token",
"default": "",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "fetch_categories",
"title": "fetch_categories",
"description": "\n\nExample(s):\n```\n{\n \"API\": \"11008\",\n \"WebUI\": \"10004\"\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_READ, SUPPORT_WRITE |
Fetch issue categories using access token |
support.fields |
---|
Return Arguments:
{
"_name_": "support_fields",
"title": "support_fields",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "support_field",
"title": "support_field",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "field",
"title": "field",
"_required_": false,
"type": "string"
}
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_READ, SUPPORT_WRITE |
Returns list of pairs of field names and field titles for Proactive Support. |
support.is_available |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "proactive_support_is_available",
"title": "proactive_support_is_available",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_READ, SUPPORT_WRITE |
Returns whether Proactive Support is available for this product type and current license. |
support.is_available_and_enabled |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "proactive_support_is_available_and_enabled",
"title": "proactive_support_is_available_and_enabled",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_READ, SUPPORT_WRITE |
Returns whether Proactive Support is available and enabled. |
support.new_ticket
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"body": {
"_name_": "body",
"title": "body",
"_required_": true,
"type": "string"
},
"category": {
"_name_": "category",
"title": "category",
"_required_": false,
"type": "string"
},
"attach_debug": {
"type": "boolean",
"_name_": "attach_debug",
"title": "attach_debug",
"default": false,
"_required_": false
},
"token": {
"_name_": "token",
"title": "token",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"BUG",
"FEATURE"
]
},
"criticality": {
"_name_": "criticality",
"title": "criticality",
"_required_": false,
"type": "string",
"description": "For SCALE `criticality`, `environment`, `phone`, `name` and `email` attributes are not required."
},
"environment": {
"_name_": "environment",
"title": "environment",
"_required_": false,
"type": "string",
"description": "For SCALE `criticality`, `environment`, `phone`, `name` and `email` attributes are not required."
},
"phone": {
"_name_": "phone",
"title": "phone",
"_required_": false,
"type": "string",
"description": "For SCALE `criticality`, `environment`, `phone`, `name` and `email` attributes are not required."
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string",
"description": "For SCALE `criticality`, `environment`, `phone`, `name` and `email` attributes are not required."
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": "string",
"description": "For SCALE `criticality`, `environment`, `phone`, `name` and `email` attributes are not required."
},
"cc": {
"_name_": "cc",
"title": "cc",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "email",
"title": "email",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "new_ticket",
"title": "new_ticket",
"default": {},
"_required_": false,
"_attrs_order_": [
"title",
"body",
"category",
"attach_debug",
"token",
"type",
"criticality",
"environment",
"phone",
"name",
"email",
"cc"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"ticket": {
"type": [
"integer",
"null"
],
"_name_": "ticket",
"title": "ticket",
"_required_": false
},
"url": {
"_name_": "url",
"title": "url",
"_required_": false,
"type": [
"string",
"null"
]
},
"has_debug": {
"type": "boolean",
"_name_": "has_debug",
"title": "has_debug",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "new_ticket_response",
"title": "new_ticket_response",
"default": {},
"_required_": false,
"_attrs_order_": [
"ticket",
"url",
"has_debug"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_WRITE |
Creates a new ticket for support. This is done using the support proxy API. For TrueNAS SCALE it will be created on JIRA and for TrueNAS SCALE Enterprise on Salesforce. For SCALE |
support.similar_issues |
---|
Arguments:
{
"_name_": "query",
"title": "query",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "similar_issues",
"title": "similar_issues",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"url": {
"_name_": "url",
"title": "url",
"_required_": false,
"type": "string"
},
"summary": {
"_name_": "summary",
"title": "summary",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "similar_issue",
"title": "similar_issue",
"default": {},
"_required_": false,
"_attrs_order_": [
"url",
"summary"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SUPPORT_READ, SUPPORT_WRITE |
- |
support.update |
---|
Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": [
"boolean",
"null"
],
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"email": {
"_name_": "email",
"title": "email",
"_required_": true,
"type": "string"
},
"phone": {
"_name_": "phone",
"title": "phone",
"_required_": true,
"type": "string"
},
"secondary_name": {
"_name_": "secondary_name",
"title": "secondary_name",
"_required_": true,
"type": "string"
},
"secondary_title": {
"_name_": "secondary_title",
"title": "secondary_title",
"_required_": true,
"type": "string"
},
"secondary_email": {
"_name_": "secondary_email",
"title": "secondary_email",
"_required_": true,
"type": "string"
},
"secondary_phone": {
"_name_": "secondary_phone",
"title": "secondary_phone",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "support_update",
"title": "support_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"name",
"title",
"email",
"phone",
"secondary_name",
"secondary_title",
"secondary_email",
"secondary_phone"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": [
"boolean",
"null"
],
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": true,
"type": "string"
},
"email": {
"_name_": "email",
"title": "email",
"_required_": true,
"type": "string"
},
"phone": {
"_name_": "phone",
"title": "phone",
"_required_": true,
"type": "string"
},
"secondary_name": {
"_name_": "secondary_name",
"title": "secondary_name",
"_required_": true,
"type": "string"
},
"secondary_title": {
"_name_": "secondary_title",
"title": "secondary_title",
"_required_": true,
"type": "string"
},
"secondary_email": {
"_name_": "secondary_email",
"title": "secondary_email",
"_required_": true,
"type": "string"
},
"secondary_phone": {
"_name_": "secondary_phone",
"title": "secondary_phone",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "support_update_returns",
"title": "support_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"name",
"title",
"email",
"phone",
"secondary_name",
"secondary_title",
"secondary_email",
"secondary_phone",
"id"
]
}
|
This method is accessible to the users granted with the following roles: SUPPORT_WRITE |
Update Proactive Support settings. |
system.boot_id |
---|
Return Arguments:
{
"_name_": "system_boot_identifier",
"title": "system_boot_identifier",
"_required_": false,
"type": "string"
}
|
Returns an unique boot identifier. It is supposed to be unique every system boot. |
system.build_time |
---|
Return Arguments:
{
"_name_": "system_build_time",
"title": "system_build_time",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Retrieve build time of the system. |
system.debug |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Download a debug file. |
system.feature_enabled |
---|
Arguments:
{
"_name_": "feature",
"title": "feature",
"_required_": false,
"type": "string",
"enum": [
"DEDUP",
"FIBRECHANNEL",
"VM"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "feature_enabled",
"title": "feature_enabled",
"_required_": false
}
|
Returns whether the |
system.host_id |
---|
Return Arguments:
{
"_name_": "system_host_identifier",
"title": "system_host_identifier",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Retrieve a hex string that is generated based
on the contents of the |
system.info |
---|
Return Arguments:
{
"type": "object",
"properties": {
"version": {
"_name_": "version",
"title": "TrueNAS Version",
"_required_": true,
"type": "string"
},
"buildtime": {
"_name_": "buildtime",
"title": "TrueNAS build time",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "System host name",
"_required_": true,
"type": "string"
},
"physmem": {
"type": "integer",
"_name_": "physmem",
"title": "System physical memory",
"_required_": true
},
"model": {
"_name_": "model",
"title": "CPU Model",
"_required_": true,
"type": "string"
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "CPU Cores",
"_required_": true
},
"physical_cores": {
"type": "integer",
"_name_": "physical_cores",
"title": "CPU Physical Cores",
"_required_": true
},
"loadavg": {
"_name_": "loadavg",
"title": "loadavg",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"uptime": {
"_name_": "uptime",
"title": "uptime",
"_required_": true,
"type": "string"
},
"uptime_seconds": {
"type": "float",
"_name_": "uptime_seconds",
"title": "uptime_seconds",
"_required_": true
},
"system_serial": {
"_name_": "system_serial",
"title": "system_serial",
"_required_": true,
"type": [
"string",
"null"
]
},
"system_product": {
"_name_": "system_product",
"title": "system_product",
"_required_": true,
"type": [
"string",
"null"
]
},
"system_product_version": {
"_name_": "system_product_version",
"title": "system_product_version",
"_required_": true,
"type": [
"string",
"null"
]
},
"license": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "license",
"title": "license",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"boottime": {
"_name_": "boottime",
"title": "boottime",
"_required_": true,
"type": "string"
},
"datetime": {
"_name_": "datetime",
"title": "datetime",
"_required_": true,
"type": "string"
},
"timezone": {
"_name_": "timezone",
"title": "timezone",
"_required_": true,
"type": "string"
},
"system_manufacturer": {
"_name_": "system_manufacturer",
"title": "system_manufacturer",
"_required_": true,
"type": [
"string",
"null"
]
},
"ecc_memory": {
"type": "boolean",
"_name_": "ecc_memory",
"title": "ecc_memory",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_info",
"title": "system_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"version",
"buildtime",
"hostname",
"physmem",
"model",
"cores",
"physical_cores",
"loadavg",
"uptime",
"uptime_seconds",
"system_serial",
"system_product",
"system_product_version",
"license",
"boottime",
"datetime",
"timezone",
"system_manufacturer",
"ecc_memory"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns basic system information. |
system.is_stable |
---|
Return Arguments:
{
"_name_": "is_stable",
"title": "is_stable",
"_required_": false,
"type": "string"
}
|
Returns whether software version of the system is stable. |
system.license_update |
---|
Arguments:
{
"_name_": "license",
"title": "license",
"_required_": false,
"type": "string"
}
|
Update license file |
system.product_type |
---|
Return Arguments:
{
"_name_": "product_type",
"title": "product_type",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns the type of the product. SCALE - TrueNAS SCALE, community version SCALE_ENTERPRISE - TrueNAS SCALE Enterprise, appliance version |
system.ready |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "system_ready",
"title": "system_ready",
"_required_": false
}
|
Returns whether the system completed boot and is ready to use |
system.reboot
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"delay": {
"type": "integer",
"_name_": "delay",
"title": "delay",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "system-reboot",
"title": "system-reboot",
"default": {},
"_required_": false,
"_attrs_order_": [
"delay"
]
}
|
Reboots the operating system. Emits an "added" event of name "system" and id "reboot". |
system.release_notes_url |
---|
Arguments:
{
"_name_": "version_str",
"title": "version_str",
"default": null,
"_required_": false,
"type": "string",
"description": "`version_str` str: represents a version to check against"
}
|
Return Arguments:
{
"_name_": "truenas_release_notes_url",
"title": "truenas_release_notes_url",
"_required_": false,
"type": [
"string",
"null"
]
}
|
Returns the release notes URL for a version of SCALE.
If |
system.shutdown
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"delay": {
"type": "integer",
"_name_": "delay",
"title": "delay",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "system-shutdown",
"title": "system-shutdown",
"default": {},
"_required_": false,
"_attrs_order_": [
"delay"
]
}
|
Shuts down the operating system. An "added" event of name "system" and id "shutdown" is emitted when shutdown is initiated. |
system.state |
---|
Return Arguments:
{
"_name_": "system_state",
"title": "system_state",
"_required_": false,
"type": "string",
"enum": [
"SHUTTING_DOWN",
"READY",
"BOOTING"
]
}
|
Returns system state: "BOOTING" - System is booting "READY" - System completed boot and is ready to use "SHUTTING_DOWN" - System is shutting down |
system.version |
---|
Return Arguments:
{
"_name_": "truenas_version",
"title": "truenas_version",
"_required_": false,
"type": "string"
}
|
Returns the full name of the software version of the system. |
system.version_short |
---|
Return Arguments:
{
"_name_": "truenas_version_shortname",
"title": "truenas_version_shortname",
"_required_": false,
"type": "string"
}
|
Returns the short name of the software version of the system. |
system.advanced.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"advancedmode": {
"type": "boolean",
"_name_": "advancedmode",
"title": "advancedmode",
"_required_": true
},
"autotune": {
"type": "boolean",
"_name_": "autotune",
"title": "autotune",
"_required_": true
},
"kdump_enabled": {
"type": "boolean",
"_name_": "kdump_enabled",
"title": "kdump_enabled",
"_required_": true
},
"boot_scrub": {
"type": "integer",
"_name_": "boot_scrub",
"title": "boot_scrub",
"_required_": true
},
"consolemenu": {
"type": "boolean",
"_name_": "consolemenu",
"title": "consolemenu",
"_required_": true
},
"consolemsg": {
"type": "boolean",
"_name_": "consolemsg",
"title": "consolemsg",
"_required_": true
},
"debugkernel": {
"type": "boolean",
"_name_": "debugkernel",
"title": "debugkernel",
"_required_": true
},
"fqdn_syslog": {
"type": "boolean",
"_name_": "fqdn_syslog",
"title": "fqdn_syslog",
"_required_": true
},
"motd": {
"_name_": "motd",
"title": "motd",
"_required_": true,
"type": "string"
},
"login_banner": {
"_name_": "login_banner",
"title": "login_banner",
"_required_": true,
"type": "string"
},
"powerdaemon": {
"type": "boolean",
"_name_": "powerdaemon",
"title": "powerdaemon",
"_required_": true
},
"serialconsole": {
"type": "boolean",
"_name_": "serialconsole",
"title": "serialconsole",
"_required_": true
},
"serialport": {
"_name_": "serialport",
"title": "serialport",
"_required_": true,
"type": "string"
},
"anonstats_token": {
"_name_": "anonstats_token",
"title": "anonstats_token",
"_required_": true,
"type": "string"
},
"serialspeed": {
"_name_": "serialspeed",
"title": "serialspeed",
"_required_": true,
"type": "string",
"enum": [
"9600",
"19200",
"38400",
"57600",
"115200"
]
},
"overprovision": {
"type": [
"integer",
"null"
],
"_name_": "overprovision",
"title": "overprovision",
"_required_": true
},
"traceback": {
"type": "boolean",
"_name_": "traceback",
"title": "traceback",
"_required_": true
},
"uploadcrash": {
"type": "boolean",
"_name_": "uploadcrash",
"title": "uploadcrash",
"_required_": true
},
"anonstats": {
"type": "boolean",
"_name_": "anonstats",
"title": "anonstats",
"_required_": true
},
"sed_user": {
"_name_": "sed_user",
"title": "sed_user",
"_required_": true,
"type": "string",
"enum": [
"USER",
"MASTER"
]
},
"sysloglevel": {
"_name_": "sysloglevel",
"title": "sysloglevel",
"_required_": true,
"type": "string",
"enum": [
"F_EMERG",
"F_ALERT",
"F_CRIT",
"F_ERR",
"F_WARNING",
"F_NOTICE",
"F_INFO",
"F_DEBUG"
]
},
"syslogserver": {
"_name_": "syslogserver",
"title": "syslogserver",
"_required_": false,
"type": "string"
},
"syslog_transport": {
"_name_": "syslog_transport",
"title": "syslog_transport",
"_required_": true,
"type": "string",
"enum": [
"UDP",
"TCP",
"TLS"
]
},
"syslog_tls_certificate": {
"type": [
"integer",
"null"
],
"_name_": "syslog_tls_certificate",
"title": "syslog_tls_certificate",
"_required_": true
},
"syslog_tls_certificate_authority": {
"type": [
"integer",
"null"
],
"_name_": "syslog_tls_certificate_authority",
"title": "syslog_tls_certificate_authority",
"_required_": true
},
"syslog_audit": {
"type": "boolean",
"_name_": "syslog_audit",
"title": "syslog_audit",
"_required_": false
},
"isolated_gpu_pci_ids": {
"_name_": "isolated_gpu_pci_ids",
"title": "isolated_gpu_pci_ids",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "pci_id",
"title": "pci_id",
"_required_": false,
"type": "string"
}
]
},
"kernel_extra_options": {
"_name_": "kernel_extra_options",
"title": "kernel_extra_options",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_advanced_entry",
"title": "system_advanced_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"advancedmode",
"autotune",
"kdump_enabled",
"boot_scrub",
"consolemenu",
"consolemsg",
"debugkernel",
"fqdn_syslog",
"motd",
"login_banner",
"powerdaemon",
"serialconsole",
"serialport",
"anonstats_token",
"serialspeed",
"overprovision",
"traceback",
"uploadcrash",
"anonstats",
"sed_user",
"sysloglevel",
"syslogserver",
"syslog_transport",
"syslog_tls_certificate",
"syslog_tls_certificate_authority",
"syslog_audit",
"isolated_gpu_pci_ids",
"kernel_extra_options",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_ADVANCED_READ, SYSTEM_ADVANCED_WRITE |
- |
system.advanced.get_gpu_pci_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "get_gpu_pci_choices",
"title": "get_gpu_pci_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_ADVANCED_READ, SYSTEM_ADVANCED_WRITE |
This endpoint gives all the gpu pci ids/slots that can be isolated. |
system.advanced.login_banner |
---|
Return Arguments:
{
"_name_": "login_banner",
"title": "login_banner",
"_required_": false,
"type": "string"
}
|
Returns user set login banner |
system.advanced.sed_global_password |
---|
Return Arguments:
{
"_name_": "sed_global_password",
"title": "sed_global_password",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_ADVANCED_READ, SYSTEM_ADVANCED_WRITE |
Returns configured global SED password in clear-text if one is configured, otherwise an empty string |
system.advanced.sed_global_password_is_set |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "sed_global_password_is_set",
"title": "sed_global_password_is_set",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_ADVANCED_READ, SYSTEM_ADVANCED_WRITE |
Returns a boolean identifying whether or not a global SED password has been set |
system.advanced.serial_port_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "serial_port_choices",
"title": "serial_port_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_ADVANCED_READ, SYSTEM_ADVANCED_WRITE |
Get available choices for |
system.advanced.syslog_certificate_authority_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "syslog_certificate_authority_choices",
"title": "Syslog Certificate Authority Choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_ADVANCED_READ, SYSTEM_ADVANCED_WRITE |
Return choices of certificate authorities which can be used for |
system.advanced.syslog_certificate_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "syslog_certificate_choices",
"title": "Syslog Certificate Choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_ADVANCED_READ, SYSTEM_ADVANCED_WRITE |
Return choices of certificates which can be used for |
system.advanced.update |
---|
Arguments:
{
"type": "object",
"properties": {
"advancedmode": {
"type": "boolean",
"_name_": "advancedmode",
"title": "advancedmode",
"_required_": true
},
"autotune": {
"type": "boolean",
"_name_": "autotune",
"title": "autotune",
"_required_": true,
"description": "`autotune` when enabled executes autotune script which attempts to optimize the system based on the installed\nhardware."
},
"kdump_enabled": {
"type": "boolean",
"_name_": "kdump_enabled",
"title": "kdump_enabled",
"_required_": true
},
"boot_scrub": {
"type": "integer",
"_name_": "boot_scrub",
"title": "boot_scrub",
"_required_": true
},
"consolemenu": {
"type": "boolean",
"_name_": "consolemenu",
"title": "consolemenu",
"_required_": true,
"description": "`consolemenu` should be disabled if the menu at console is not desired. It will default to standard login\nin the console if disabled."
},
"consolemsg": {
"type": "boolean",
"_name_": "consolemsg",
"title": "consolemsg",
"_required_": true
},
"debugkernel": {
"type": "boolean",
"_name_": "debugkernel",
"title": "debugkernel",
"_required_": true
},
"fqdn_syslog": {
"type": "boolean",
"_name_": "fqdn_syslog",
"title": "fqdn_syslog",
"_required_": true
},
"motd": {
"_name_": "motd",
"title": "motd",
"_required_": true,
"type": "string"
},
"login_banner": {
"_name_": "login_banner",
"title": "login_banner",
"_required_": true,
"type": "string"
},
"powerdaemon": {
"type": "boolean",
"_name_": "powerdaemon",
"title": "powerdaemon",
"_required_": true
},
"serialconsole": {
"type": "boolean",
"_name_": "serialconsole",
"title": "serialconsole",
"_required_": true
},
"serialport": {
"_name_": "serialport",
"title": "serialport",
"_required_": true,
"type": "string"
},
"serialspeed": {
"_name_": "serialspeed",
"title": "serialspeed",
"_required_": true,
"type": "string",
"enum": [
"9600",
"19200",
"38400",
"57600",
"115200"
]
},
"overprovision": {
"type": [
"integer",
"null"
],
"_name_": "overprovision",
"title": "overprovision",
"_required_": true
},
"traceback": {
"type": "boolean",
"_name_": "traceback",
"title": "traceback",
"_required_": true
},
"uploadcrash": {
"type": "boolean",
"_name_": "uploadcrash",
"title": "uploadcrash",
"_required_": true
},
"anonstats": {
"type": "boolean",
"_name_": "anonstats",
"title": "anonstats",
"_required_": true
},
"sed_user": {
"_name_": "sed_user",
"title": "sed_user",
"_required_": true,
"type": "string",
"enum": [
"USER",
"MASTER"
]
},
"sysloglevel": {
"_name_": "sysloglevel",
"title": "sysloglevel",
"_required_": true,
"type": "string",
"enum": [
"F_EMERG",
"F_ALERT",
"F_CRIT",
"F_ERR",
"F_WARNING",
"F_NOTICE",
"F_INFO",
"F_DEBUG"
],
"description": "When `syslogserver` is defined, logs of `sysloglevel` or above are sent. If syslog_audit is also set\nthen the remote syslog server will also receive audit messages."
},
"syslogserver": {
"_name_": "syslogserver",
"title": "syslogserver",
"_required_": false,
"type": "string",
"description": "When `syslogserver` is defined, logs of `sysloglevel` or above are sent. If syslog_audit is also set\nthen the remote syslog server will also receive audit messages."
},
"syslog_transport": {
"_name_": "syslog_transport",
"title": "syslog_transport",
"_required_": true,
"type": "string",
"enum": [
"UDP",
"TCP",
"TLS"
]
},
"syslog_tls_certificate": {
"type": [
"integer",
"null"
],
"_name_": "syslog_tls_certificate",
"title": "syslog_tls_certificate",
"_required_": true
},
"syslog_tls_certificate_authority": {
"type": [
"integer",
"null"
],
"_name_": "syslog_tls_certificate_authority",
"title": "syslog_tls_certificate_authority",
"_required_": true
},
"syslog_audit": {
"type": "boolean",
"_name_": "syslog_audit",
"title": "syslog_audit",
"_required_": false
},
"kernel_extra_options": {
"_name_": "kernel_extra_options",
"title": "kernel_extra_options",
"_required_": true,
"type": "string"
},
"sed_passwd": {
"_name_": "sed_passwd",
"title": "sed_passwd",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "system_advanced_update",
"title": "system_advanced_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"advancedmode",
"autotune",
"kdump_enabled",
"boot_scrub",
"consolemenu",
"consolemsg",
"debugkernel",
"fqdn_syslog",
"motd",
"login_banner",
"powerdaemon",
"serialconsole",
"serialport",
"serialspeed",
"overprovision",
"traceback",
"uploadcrash",
"anonstats",
"sed_user",
"sysloglevel",
"syslogserver",
"syslog_transport",
"syslog_tls_certificate",
"syslog_tls_certificate_authority",
"syslog_audit",
"kernel_extra_options",
"sed_passwd"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"advancedmode": {
"type": "boolean",
"_name_": "advancedmode",
"title": "advancedmode",
"_required_": true
},
"autotune": {
"type": "boolean",
"_name_": "autotune",
"title": "autotune",
"_required_": true,
"description": "`autotune` when enabled executes autotune script which attempts to optimize the system based on the installed\nhardware."
},
"kdump_enabled": {
"type": "boolean",
"_name_": "kdump_enabled",
"title": "kdump_enabled",
"_required_": true
},
"boot_scrub": {
"type": "integer",
"_name_": "boot_scrub",
"title": "boot_scrub",
"_required_": true
},
"consolemenu": {
"type": "boolean",
"_name_": "consolemenu",
"title": "consolemenu",
"_required_": true,
"description": "`consolemenu` should be disabled if the menu at console is not desired. It will default to standard login\nin the console if disabled."
},
"consolemsg": {
"type": "boolean",
"_name_": "consolemsg",
"title": "consolemsg",
"_required_": true
},
"debugkernel": {
"type": "boolean",
"_name_": "debugkernel",
"title": "debugkernel",
"_required_": true
},
"fqdn_syslog": {
"type": "boolean",
"_name_": "fqdn_syslog",
"title": "fqdn_syslog",
"_required_": true
},
"motd": {
"_name_": "motd",
"title": "motd",
"_required_": true,
"type": "string"
},
"login_banner": {
"_name_": "login_banner",
"title": "login_banner",
"_required_": true,
"type": "string"
},
"powerdaemon": {
"type": "boolean",
"_name_": "powerdaemon",
"title": "powerdaemon",
"_required_": true
},
"serialconsole": {
"type": "boolean",
"_name_": "serialconsole",
"title": "serialconsole",
"_required_": true
},
"serialport": {
"_name_": "serialport",
"title": "serialport",
"_required_": true,
"type": "string"
},
"anonstats_token": {
"_name_": "anonstats_token",
"title": "anonstats_token",
"_required_": true,
"type": "string"
},
"serialspeed": {
"_name_": "serialspeed",
"title": "serialspeed",
"_required_": true,
"type": "string",
"enum": [
"9600",
"19200",
"38400",
"57600",
"115200"
]
},
"overprovision": {
"type": [
"integer",
"null"
],
"_name_": "overprovision",
"title": "overprovision",
"_required_": true
},
"traceback": {
"type": "boolean",
"_name_": "traceback",
"title": "traceback",
"_required_": true
},
"uploadcrash": {
"type": "boolean",
"_name_": "uploadcrash",
"title": "uploadcrash",
"_required_": true
},
"anonstats": {
"type": "boolean",
"_name_": "anonstats",
"title": "anonstats",
"_required_": true
},
"sed_user": {
"_name_": "sed_user",
"title": "sed_user",
"_required_": true,
"type": "string",
"enum": [
"USER",
"MASTER"
]
},
"sysloglevel": {
"_name_": "sysloglevel",
"title": "sysloglevel",
"_required_": true,
"type": "string",
"enum": [
"F_EMERG",
"F_ALERT",
"F_CRIT",
"F_ERR",
"F_WARNING",
"F_NOTICE",
"F_INFO",
"F_DEBUG"
],
"description": "When `syslogserver` is defined, logs of `sysloglevel` or above are sent. If syslog_audit is also set\nthen the remote syslog server will also receive audit messages."
},
"syslogserver": {
"_name_": "syslogserver",
"title": "syslogserver",
"_required_": false,
"type": "string",
"description": "When `syslogserver` is defined, logs of `sysloglevel` or above are sent. If syslog_audit is also set\nthen the remote syslog server will also receive audit messages."
},
"syslog_transport": {
"_name_": "syslog_transport",
"title": "syslog_transport",
"_required_": true,
"type": "string",
"enum": [
"UDP",
"TCP",
"TLS"
]
},
"syslog_tls_certificate": {
"type": [
"integer",
"null"
],
"_name_": "syslog_tls_certificate",
"title": "syslog_tls_certificate",
"_required_": true
},
"syslog_tls_certificate_authority": {
"type": [
"integer",
"null"
],
"_name_": "syslog_tls_certificate_authority",
"title": "syslog_tls_certificate_authority",
"_required_": true
},
"syslog_audit": {
"type": "boolean",
"_name_": "syslog_audit",
"title": "syslog_audit",
"_required_": false
},
"isolated_gpu_pci_ids": {
"_name_": "isolated_gpu_pci_ids",
"title": "isolated_gpu_pci_ids",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "pci_id",
"title": "pci_id",
"_required_": false,
"type": "string"
}
]
},
"kernel_extra_options": {
"_name_": "kernel_extra_options",
"title": "kernel_extra_options",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_advanced_update_returns",
"title": "system_advanced_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"advancedmode",
"autotune",
"kdump_enabled",
"boot_scrub",
"consolemenu",
"consolemsg",
"debugkernel",
"fqdn_syslog",
"motd",
"login_banner",
"powerdaemon",
"serialconsole",
"serialport",
"anonstats_token",
"serialspeed",
"overprovision",
"traceback",
"uploadcrash",
"anonstats",
"sed_user",
"sysloglevel",
"syslogserver",
"syslog_transport",
"syslog_tls_certificate",
"syslog_tls_certificate_authority",
"syslog_audit",
"isolated_gpu_pci_ids",
"kernel_extra_options",
"id"
]
}
|
This method is accessible to the users granted with the following roles: SYSTEM_ADVANCED_WRITE |
Update System Advanced Service Configuration.
When
|
system.advanced.update_gpu_pci_ids |
---|
Arguments:
{
"_name_": "isolated_gpu_pci_ids",
"title": "isolated_gpu_pci_ids",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "pci_id",
"title": "pci_id",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: SYSTEM_ADVANCED_WRITE |
|
system.general.checkin |
---|
After UI settings are saved with This is to ensure user verifies the changes went as planned and its working. |
system.general.checkin_waiting |
---|
Return Arguments:
{
"type": [
"integer",
"null"
],
"_name_": "remaining_seconds",
"title": "remaining_seconds",
"_required_": false
}
|
Determines whether or not we are waiting user to check-in the applied UI settings changes before they are rolled back. Returns a number of seconds before the automatic rollback or null if there are no changes pending. |
system.general.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"ui_certificate": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ui_certificate",
"title": "ui_certificate",
"default": {},
"_required_": true,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
},
"ui_httpsport": {
"type": "integer",
"_name_": "ui_httpsport",
"title": "ui_httpsport",
"_required_": true
},
"ui_httpsredirect": {
"type": "boolean",
"_name_": "ui_httpsredirect",
"title": "ui_httpsredirect",
"_required_": true
},
"ui_httpsprotocols": {
"_name_": "ui_httpsprotocols",
"title": "ui_httpsprotocols",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string",
"enum": [
"TLSv1",
"TLSv1.1",
"TLSv1.2",
"TLSv1.3"
]
}
]
},
"ui_port": {
"type": "integer",
"_name_": "ui_port",
"title": "ui_port",
"_required_": true
},
"ui_address": {
"_name_": "ui_address",
"title": "ui_address",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
]
},
"ui_v6address": {
"_name_": "ui_v6address",
"title": "ui_v6address",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
]
},
"ui_allowlist": {
"_name_": "ui_allowlist",
"title": "ui_allowlist",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
]
},
"ui_consolemsg": {
"type": "boolean",
"_name_": "ui_consolemsg",
"title": "ui_consolemsg",
"_required_": true
},
"ui_x_frame_options": {
"_name_": "ui_x_frame_options",
"title": "ui_x_frame_options",
"_required_": true,
"type": "string",
"enum": [
"SAMEORIGIN",
"DENY",
"ALLOW_ALL"
]
},
"kbdmap": {
"_name_": "kbdmap",
"title": "kbdmap",
"_required_": true,
"type": "string"
},
"language": {
"_name_": "language",
"title": "language",
"_required_": true,
"type": "string"
},
"timezone": {
"_name_": "timezone",
"title": "timezone",
"_required_": true,
"type": "string"
},
"usage_collection": {
"type": [
"boolean",
"null"
],
"_name_": "usage_collection",
"title": "usage_collection",
"_required_": true
},
"wizardshown": {
"type": "boolean",
"_name_": "wizardshown",
"title": "wizardshown",
"_required_": true
},
"usage_collection_is_set": {
"type": "boolean",
"_name_": "usage_collection_is_set",
"title": "usage_collection_is_set",
"_required_": true
},
"ds_auth": {
"type": "boolean",
"_name_": "ds_auth",
"title": "ds_auth",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_general_entry",
"title": "system_general_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ui_certificate",
"ui_httpsport",
"ui_httpsredirect",
"ui_httpsprotocols",
"ui_port",
"ui_address",
"ui_v6address",
"ui_allowlist",
"ui_consolemsg",
"ui_x_frame_options",
"kbdmap",
"language",
"timezone",
"usage_collection",
"wizardshown",
"usage_collection_is_set",
"ds_auth",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
- |
system.general.country_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "country_choices",
"title": "country_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns country choices. |
system.general.kbdmap_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "kbdmap_choices",
"title": "kbdmap_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns kbdmap choices. |
system.general.language_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "system_language_choices",
"title": "System Language Choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns language choices. |
system.general.local_url |
---|
Return Arguments:
{
"_name_": "local_url",
"title": "local_url",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns configured local url in the format of protocol://host:port |
system.general.timezone_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "system_timezone_choices",
"title": "System Timezone Choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns available timezones |
system.general.ui_address_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "available_ui_address_choices",
"title": "Available UI IPv4 Address Choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns UI ipv4 address choices. |
system.general.ui_certificate_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ui_certificate_choices",
"title": "UI Certificate Choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Return choices of certificates which can be used for |
system.general.ui_httpsprotocols_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"TLSv1": {
"_name_": "TLSv1",
"title": "TLSv1",
"_required_": false,
"type": "string",
"enum": [
"TLSv1"
]
},
"TLSv1.1": {
"_name_": "TLSv1.1",
"title": "TLSv1.1",
"_required_": false,
"type": "string",
"enum": [
"TLSv1.1"
]
},
"TLSv1.2": {
"_name_": "TLSv1.2",
"title": "TLSv1.2",
"_required_": false,
"type": "string",
"enum": [
"TLSv1.2"
]
},
"TLSv1.3": {
"_name_": "TLSv1.3",
"title": "TLSv1.3",
"_required_": false,
"type": "string",
"enum": [
"TLSv1.3"
]
}
},
"additionalProperties": false,
"_name_": "ui_https_protocols",
"title": "UI HTTPS Protocol Choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"TLSv1",
"TLSv1.1",
"TLSv1.2",
"TLSv1.3"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns available HTTPS protocols. |
system.general.ui_restart |
---|
Arguments:
{
"type": "integer",
"_name_": "delay",
"title": "delay",
"default": 3,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SYSTEM_GENERAL_WRITE |
Restart HTTP server to use latest UI settings. HTTP server will be restarted after |
system.general.ui_v6address_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "available_ui_v6address_choices",
"title": "Available UI IPv6 Address Choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, SYSTEM_GENERAL_READ, SYSTEM_GENERAL_WRITE |
Returns UI ipv6 address choices. |
system.general.update |
---|
Arguments:
{
"type": "object",
"properties": {
"ui_httpsport": {
"type": "integer",
"_name_": "ui_httpsport",
"title": "ui_httpsport",
"_required_": true
},
"ui_httpsredirect": {
"type": "boolean",
"_name_": "ui_httpsredirect",
"title": "ui_httpsredirect",
"_required_": true,
"description": "`ui_httpsredirect` when set, makes sure that all HTTP requests are converted to HTTPS requests to better\nenhance security."
},
"ui_httpsprotocols": {
"_name_": "ui_httpsprotocols",
"title": "ui_httpsprotocols",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string",
"enum": [
"TLSv1",
"TLSv1.1",
"TLSv1.2",
"TLSv1.3"
]
}
]
},
"ui_port": {
"type": "integer",
"_name_": "ui_port",
"title": "ui_port",
"_required_": true
},
"ui_address": {
"_name_": "ui_address",
"title": "ui_address",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
],
"description": "`ui_address` and `ui_v6address` are a list of valid ipv4/ipv6 addresses respectively which the system will\nlisten on."
},
"ui_v6address": {
"_name_": "ui_v6address",
"title": "ui_v6address",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
],
"description": "`ui_address` and `ui_v6address` are a list of valid ipv4/ipv6 addresses respectively which the system will\nlisten on."
},
"ui_allowlist": {
"_name_": "ui_allowlist",
"title": "ui_allowlist",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
],
"description": "`ui_allowlist` is a list of IP addresses and networks that are allow to use API and UI. If this list is empty,\nthen all IP addresses are allowed to use API and UI."
},
"ui_consolemsg": {
"type": "boolean",
"_name_": "ui_consolemsg",
"title": "ui_consolemsg",
"_required_": true
},
"ui_x_frame_options": {
"_name_": "ui_x_frame_options",
"title": "ui_x_frame_options",
"_required_": true,
"type": "string",
"enum": [
"SAMEORIGIN",
"DENY",
"ALLOW_ALL"
]
},
"kbdmap": {
"_name_": "kbdmap",
"title": "kbdmap",
"_required_": true,
"type": "string"
},
"language": {
"_name_": "language",
"title": "language",
"_required_": true,
"type": "string"
},
"timezone": {
"_name_": "timezone",
"title": "timezone",
"_required_": true,
"type": "string"
},
"usage_collection": {
"type": [
"boolean",
"null"
],
"_name_": "usage_collection",
"title": "usage_collection",
"_required_": true
},
"ds_auth": {
"type": "boolean",
"_name_": "ds_auth",
"title": "ds_auth",
"_required_": true,
"description": "`ds_auth` controls whether configured Directory Service users that are granted with Privileges are allowed to\nlog in to the Web UI or use TrueNAS API."
},
"ui_certificate": {
"type": [
"integer",
"null"
],
"_name_": "ui_certificate",
"title": "ui_certificate",
"_required_": false,
"description": "`ui_certificate` is used to enable HTTPS access to the system. If `ui_certificate` is not configured on boot,\nit is automatically created by the system."
},
"rollback_timeout": {
"type": [
"integer",
"null"
],
"_name_": "rollback_timeout",
"title": "rollback_timeout",
"_required_": false
},
"ui_restart_delay": {
"type": [
"integer",
"null"
],
"_name_": "ui_restart_delay",
"title": "ui_restart_delay",
"_required_": false,
"description": "HTTP connections will be aborted) or specify `ui_restart_delay` (in seconds) to automatically apply them after\nsome small amount of time necessary you might need to receive the response for your settings update request."
}
},
"additionalProperties": false,
"_name_": "general_settings",
"title": "general_settings",
"default": {},
"_required_": false,
"_attrs_order_": [
"ui_httpsport",
"ui_httpsredirect",
"ui_httpsprotocols",
"ui_port",
"ui_address",
"ui_v6address",
"ui_allowlist",
"ui_consolemsg",
"ui_x_frame_options",
"kbdmap",
"language",
"timezone",
"usage_collection",
"ds_auth",
"ui_certificate",
"rollback_timeout",
"ui_restart_delay"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"ui_certificate": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ui_certificate",
"title": "ui_certificate",
"default": {},
"_required_": true,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
],
"description": "`ui_certificate` is used to enable HTTPS access to the system. If `ui_certificate` is not configured on boot,\nit is automatically created by the system."
},
"ui_httpsport": {
"type": "integer",
"_name_": "ui_httpsport",
"title": "ui_httpsport",
"_required_": true
},
"ui_httpsredirect": {
"type": "boolean",
"_name_": "ui_httpsredirect",
"title": "ui_httpsredirect",
"_required_": true,
"description": "`ui_httpsredirect` when set, makes sure that all HTTP requests are converted to HTTPS requests to better\nenhance security."
},
"ui_httpsprotocols": {
"_name_": "ui_httpsprotocols",
"title": "ui_httpsprotocols",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string",
"enum": [
"TLSv1",
"TLSv1.1",
"TLSv1.2",
"TLSv1.3"
]
}
]
},
"ui_port": {
"type": "integer",
"_name_": "ui_port",
"title": "ui_port",
"_required_": true
},
"ui_address": {
"_name_": "ui_address",
"title": "ui_address",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
],
"description": "`ui_address` and `ui_v6address` are a list of valid ipv4/ipv6 addresses respectively which the system will\nlisten on."
},
"ui_v6address": {
"_name_": "ui_v6address",
"title": "ui_v6address",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
],
"description": "`ui_address` and `ui_v6address` are a list of valid ipv4/ipv6 addresses respectively which the system will\nlisten on."
},
"ui_allowlist": {
"_name_": "ui_allowlist",
"title": "ui_allowlist",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "addr",
"title": "addr",
"_required_": false,
"type": "string"
}
],
"description": "`ui_allowlist` is a list of IP addresses and networks that are allow to use API and UI. If this list is empty,\nthen all IP addresses are allowed to use API and UI."
},
"ui_consolemsg": {
"type": "boolean",
"_name_": "ui_consolemsg",
"title": "ui_consolemsg",
"_required_": true
},
"ui_x_frame_options": {
"_name_": "ui_x_frame_options",
"title": "ui_x_frame_options",
"_required_": true,
"type": "string",
"enum": [
"SAMEORIGIN",
"DENY",
"ALLOW_ALL"
]
},
"kbdmap": {
"_name_": "kbdmap",
"title": "kbdmap",
"_required_": true,
"type": "string"
},
"language": {
"_name_": "language",
"title": "language",
"_required_": true,
"type": "string"
},
"timezone": {
"_name_": "timezone",
"title": "timezone",
"_required_": true,
"type": "string"
},
"usage_collection": {
"type": [
"boolean",
"null"
],
"_name_": "usage_collection",
"title": "usage_collection",
"_required_": true
},
"wizardshown": {
"type": "boolean",
"_name_": "wizardshown",
"title": "wizardshown",
"_required_": true
},
"usage_collection_is_set": {
"type": "boolean",
"_name_": "usage_collection_is_set",
"title": "usage_collection_is_set",
"_required_": true
},
"ds_auth": {
"type": "boolean",
"_name_": "ds_auth",
"title": "ds_auth",
"_required_": true,
"description": "`ds_auth` controls whether configured Directory Service users that are granted with Privileges are allowed to\nlog in to the Web UI or use TrueNAS API."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_general_update_returns",
"title": "system_general_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"ui_certificate",
"ui_httpsport",
"ui_httpsredirect",
"ui_httpsprotocols",
"ui_port",
"ui_address",
"ui_v6address",
"ui_allowlist",
"ui_consolemsg",
"ui_x_frame_options",
"kbdmap",
"language",
"timezone",
"usage_collection",
"wizardshown",
"usage_collection_is_set",
"ds_auth",
"id"
]
}
|
This method is accessible to the users granted with the following roles: SYSTEM_GENERAL_WRITE |
Update System General Service Configuration.
UI configuration is not applied automatically. Call If incorrect UI configuration is applied, you might loss API connectivity and won't be able to fix the settings.
To avoid that, specify |
system.global.id |
---|
Return Arguments:
{
"_name_": "system_uuid",
"title": "system_uuid",
"_required_": false,
"type": "string"
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Retrieve a 128 bit hexadecimal UUID value unique for each TrueNAS system. |
system.ntpserver.create |
---|
Arguments:
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string",
"description": "`address` specifies the hostname/IP address of the NTP server."
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false,
"description": "`burst` when enabled makes sure that if server is reachable, sends a burst of eight packets instead of one.\nThis is designed to improve timekeeping quality with the server command."
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false,
"description": "`iburst` when enabled speeds up the initial synchronization, taking seconds rather than minutes."
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false,
"description": "`prefer` marks the specified server as preferred. When all other things are equal, this host is chosen\nfor synchronization acquisition with the server command. It is recommended that they be used for servers with\ntime monitoring hardware."
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ntp_create",
"title": "ntp_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"force"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string",
"description": "`address` specifies the hostname/IP address of the NTP server."
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false,
"description": "`burst` when enabled makes sure that if server is reachable, sends a burst of eight packets instead of one.\nThis is designed to improve timekeeping quality with the server command."
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false,
"description": "`iburst` when enabled speeds up the initial synchronization, taking seconds rather than minutes."
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false,
"description": "`prefer` marks the specified server as preferred. When all other things are equal, this host is chosen\nfor synchronization acquisition with the server command. It is recommended that they be used for servers with\ntime monitoring hardware."
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "system_ntpserver_create_returns",
"title": "system_ntpserver_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"id"
]
}
|
Add an NTP Server.
|
system.ntpserver.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete NTP server of |
system.ntpserver.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "ntp_entry",
"title": "ntp_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
system.ntpserver.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ntp_entry",
"title": "ntp_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ntp_entry",
"title": "ntp_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ntp_entry",
"title": "ntp_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
system.ntpserver.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update NTP server of `id`.\nAdd an NTP Server."
}
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string",
"description": "`address` specifies the hostname/IP address of the NTP server."
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false,
"description": "`burst` when enabled makes sure that if server is reachable, sends a burst of eight packets instead of one.\nThis is designed to improve timekeeping quality with the server command."
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false,
"description": "`iburst` when enabled speeds up the initial synchronization, taking seconds rather than minutes."
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false,
"description": "`prefer` marks the specified server as preferred. When all other things are equal, this host is chosen\nfor synchronization acquisition with the server command. It is recommended that they be used for servers with\ntime monitoring hardware."
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ntp_update",
"title": "ntp_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"force"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string",
"description": "`address` specifies the hostname/IP address of the NTP server."
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false,
"description": "`burst` when enabled makes sure that if server is reachable, sends a burst of eight packets instead of one.\nThis is designed to improve timekeeping quality with the server command."
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false,
"description": "`iburst` when enabled speeds up the initial synchronization, taking seconds rather than minutes."
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false,
"description": "`prefer` marks the specified server as preferred. When all other things are equal, this host is chosen\nfor synchronization acquisition with the server command. It is recommended that they be used for servers with\ntime monitoring hardware."
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false,
"description": "`minpoll` is minimum polling time in seconds. It must be a power of 2 and less than `maxpoll`.\n`maxpoll` is maximum polling time in seconds. It must be a power of 2 and greater than `minpoll`."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update NTP server of `id`.\nAdd an NTP Server."
}
},
"additionalProperties": false,
"_name_": "system_ntpserver_update_returns",
"title": "system_ntpserver_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"id"
]
}
|
Update NTP server of |
system.security.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"enable_fips": {
"type": "boolean",
"_name_": "enable_fips",
"title": "enable_fips",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_security_entry",
"title": "system_security_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable_fips",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
system.security.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"enable_fips": {
"type": "boolean",
"_name_": "enable_fips",
"title": "enable_fips",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_security_update",
"title": "system_security_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable_fips"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"enable_fips": {
"type": "boolean",
"_name_": "enable_fips",
"title": "enable_fips",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "system_security_update_returns",
"title": "system_security_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"enable_fips",
"id"
]
}
|
Update System Security Service Configuration.
|
system.security.info.fips_available |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "fips_available",
"title": "fips_available",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns a boolean identifying whether or not FIPS mode may be toggled on this system |
system.security.info.fips_enabled |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "fips_available",
"title": "fips_available",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns a boolean identifying whether or not FIPS mode has been enabled on this system |
systemdataset.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"pool_set": {
"type": "boolean",
"_name_": "pool_set",
"title": "pool_set",
"_required_": true
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"_required_": true,
"type": "string"
},
"basename": {
"_name_": "basename",
"title": "basename",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "systemdataset_entry",
"title": "systemdataset_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"pool",
"pool_set",
"uuid",
"basename",
"path"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
systemdataset.pool_choices |
---|
Arguments:
{
"type": "boolean",
"_name_": "include_current_pool",
"title": "include_current_pool",
"default": true,
"_required_": false
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "systemdataset_pool_choices",
"title": "systemdataset_pool_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Retrieve pool choices which can be used for configuring system dataset. |
systemdataset.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`pool` is the name of a valid pool configured in the system which will be used to host the system dataset."
},
"pool_exclude": {
"_name_": "pool_exclude",
"title": "pool_exclude",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "sysdataset_update",
"title": "sysdataset_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"pool_exclude"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string",
"description": "`pool` is the name of a valid pool configured in the system which will be used to host the system dataset."
},
"pool_set": {
"type": "boolean",
"_name_": "pool_set",
"title": "pool_set",
"_required_": true
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"_required_": true,
"type": "string"
},
"basename": {
"_name_": "basename",
"title": "basename",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "systemdataset_update_returns",
"title": "systemdataset_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"pool",
"pool_set",
"uuid",
"basename",
"path"
]
}
|
Update System Dataset Service Configuration.
|
truecommand.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"api_key": {
"_name_": "api_key",
"title": "api_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string",
"enum": [
"CONNECTED",
"CONNECTING",
"DISABLED",
"FAILED"
]
},
"status_reason": {
"_name_": "status_reason",
"title": "status_reason",
"_required_": true,
"type": "string",
"enum": [
"Truecommand service is connected.",
"Pending Confirmation From iX Portal for Truecommand API Key.",
"Truecommand service is disabled.",
"Truecommand API Key Disabled by iX Portal.",
"Waiting for connection from Truecommand."
]
},
"remote_url": {
"_name_": "remote_url",
"title": "remote_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"remote_ip_address": {
"_name_": "remote_ip_address",
"title": "remote_ip_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "truecommand_entry",
"title": "truecommand_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"api_key",
"status",
"status_reason",
"remote_url",
"remote_ip_address",
"enabled"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, TRUECOMMAND_READ, TRUECOMMAND_WRITE |
- |
truecommand.info |
---|
Return Arguments:
{
"type": "object",
"properties": {
"connected": {
"type": "boolean",
"_name_": "connected",
"title": "connected",
"_required_": true
},
"truecommand_ip": {
"_name_": "truecommand_ip",
"title": "truecommand_ip",
"_required_": true,
"type": [
"string",
"null"
]
},
"truecommand_url": {
"_name_": "truecommand_url",
"title": "truecommand_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"status_reason": {
"_name_": "status_reason",
"title": "status_reason",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "truecommand_connected",
"title": "truecommand_connected",
"default": {},
"_required_": false,
"_attrs_order_": [
"connected",
"truecommand_ip",
"truecommand_url",
"status",
"status_reason"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, TRUECOMMAND_READ, TRUECOMMAND_WRITE |
Returns information which shows if system has an authenticated api key and has initiated a VPN connection with TrueCommand. |
truecommand.update |
---|
Arguments:
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"api_key": {
"_name_": "api_key",
"title": "api_key",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "truecommand_update",
"title": "truecommand_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"api_key"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"api_key": {
"_name_": "api_key",
"title": "api_key",
"_required_": true,
"type": [
"string",
"null"
]
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string",
"enum": [
"CONNECTED",
"CONNECTING",
"DISABLED",
"FAILED"
]
},
"status_reason": {
"_name_": "status_reason",
"title": "status_reason",
"_required_": true,
"type": "string",
"enum": [
"Truecommand service is connected.",
"Pending Confirmation From iX Portal for Truecommand API Key.",
"Truecommand service is disabled.",
"Truecommand API Key Disabled by iX Portal.",
"Waiting for connection from Truecommand."
]
},
"remote_url": {
"_name_": "remote_url",
"title": "remote_url",
"_required_": true,
"type": [
"string",
"null"
]
},
"remote_ip_address": {
"_name_": "remote_ip_address",
"title": "remote_ip_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "truecommand_update_returns",
"title": "truecommand_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"api_key",
"status",
"status_reason",
"remote_url",
"remote_ip_address",
"enabled"
]
}
|
This method is accessible to the users granted with the following roles: TRUECOMMAND_WRITE |
Update Truecommand service settings.
|
truenas.accept_eula |
---|
Accept TrueNAS EULA. |
truenas.get_chassis_hardware |
---|
Return Arguments:
{
"_name_": "system_chassis_hardware",
"title": "system_chassis_hardware",
"_required_": false,
"type": "string"
}
|
Returns what type of hardware this is, detected from dmidecode. |
truenas.get_customer_information |
---|
Returns stored customer information. |
truenas.get_eula |
---|
Return Arguments:
{
"_name_": "eula",
"title": "eula",
"_required_": false,
"type": [
"string",
"null"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns the TrueNAS End-User License Agreement (EULA). |
truenas.is_eula_accepted |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "system_eula_accepted",
"title": "system_eula_accepted",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns whether the EULA is accepted or not. |
truenas.is_ix_hardware |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "is_ix_hardware",
"title": "is_ix_hardware",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Return a boolean value on whether this is hardware that iXsystems sells. |
truenas.is_production |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "is_production_system",
"title": "is_production_system",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns if system is marked as production. |
truenas.managed_by_truecommand |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "managed_by_truecommand",
"title": "managed_by_truecommand",
"_required_": false
}
|
Returns whether TrueNAS is being managed by TrueCommand or not. This endpoint has no authentication required as it is used by UI when the user has not logged in to see if the system is being managed by TrueCommand or not. |
truenas.set_production
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "boolean",
"_name_": "production",
"title": "production",
"_required_": false
}
{
"type": "boolean",
"_name_": "attach_debug",
"title": "attach_debug",
"default": false,
"_required_": false
}
|
Return Arguments:
{
"type": "object",
"properties": {
"ticket": {
"type": [
"integer",
"null"
],
"_name_": "ticket",
"title": "ticket",
"_required_": false
},
"url": {
"_name_": "url",
"title": "url",
"_required_": false,
"type": [
"string",
"null"
]
},
"has_debug": {
"type": "boolean",
"_name_": "has_debug",
"title": "has_debug",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "set_production",
"title": "set_production",
"default": {},
"_required_": false,
"_attrs_order_": [
"ticket",
"url",
"has_debug"
]
}
|
Sets system production state and optionally sends initial debug. |
truenas.update_customer_information |
---|
Arguments:
{
"type": "object",
"properties": {
"company": {
"_name_": "company",
"title": "company",
"_required_": false,
"type": "string"
},
"administrative_user": {
"type": "object",
"properties": {
"first_name": {
"_name_": "first_name",
"title": "first_name",
"_required_": false,
"type": "string"
},
"last_name": {
"_name_": "last_name",
"title": "last_name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"office_phone": {
"_name_": "office_phone",
"title": "office_phone",
"_required_": false,
"type": "string"
},
"mobile_phone": {
"_name_": "mobile_phone",
"title": "mobile_phone",
"_required_": false,
"type": "string"
},
"primary_email": {
"_name_": "primary_email",
"title": "primary_email",
"_required_": false,
"type": "string"
},
"secondary_email": {
"_name_": "secondary_email",
"title": "secondary_email",
"_required_": false,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"zip": {
"_name_": "zip",
"title": "zip",
"_required_": false,
"type": "string"
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "administrative_user",
"title": "administrative_user",
"default": {},
"_required_": false,
"_attrs_order_": [
"first_name",
"last_name",
"title",
"office_phone",
"mobile_phone",
"primary_email",
"secondary_email",
"address",
"city",
"state",
"zip",
"country"
]
},
"technical_user": {
"type": "object",
"properties": {
"first_name": {
"_name_": "first_name",
"title": "first_name",
"_required_": false,
"type": "string"
},
"last_name": {
"_name_": "last_name",
"title": "last_name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"office_phone": {
"_name_": "office_phone",
"title": "office_phone",
"_required_": false,
"type": "string"
},
"mobile_phone": {
"_name_": "mobile_phone",
"title": "mobile_phone",
"_required_": false,
"type": "string"
},
"primary_email": {
"_name_": "primary_email",
"title": "primary_email",
"_required_": false,
"type": "string"
},
"secondary_email": {
"_name_": "secondary_email",
"title": "secondary_email",
"_required_": false,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"zip": {
"_name_": "zip",
"title": "zip",
"_required_": false,
"type": "string"
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "technical_user",
"title": "technical_user",
"default": {},
"_required_": false,
"_attrs_order_": [
"first_name",
"last_name",
"title",
"office_phone",
"mobile_phone",
"primary_email",
"secondary_email",
"address",
"city",
"state",
"zip",
"country"
]
},
"reseller": {
"type": "object",
"properties": {
"company": {
"_name_": "company",
"title": "company",
"_required_": false,
"type": "string"
},
"first_name": {
"_name_": "first_name",
"title": "first_name",
"_required_": false,
"type": "string"
},
"last_name": {
"_name_": "last_name",
"title": "last_name",
"_required_": false,
"type": "string"
},
"title": {
"_name_": "title",
"title": "title",
"_required_": false,
"type": "string"
},
"office_phone": {
"_name_": "office_phone",
"title": "office_phone",
"_required_": false,
"type": "string"
},
"mobile_phone": {
"_name_": "mobile_phone",
"title": "mobile_phone",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reseller",
"title": "reseller",
"default": {},
"_required_": false,
"_attrs_order_": [
"company",
"first_name",
"last_name",
"title",
"office_phone",
"mobile_phone"
]
},
"physical_location": {
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"zip": {
"_name_": "zip",
"title": "zip",
"_required_": false,
"type": "string"
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": "string"
},
"contact_name": {
"_name_": "contact_name",
"title": "contact_name",
"_required_": false,
"type": "string"
},
"contact_phone_number": {
"_name_": "contact_phone_number",
"title": "contact_phone_number",
"_required_": false,
"type": "string"
},
"contact_email": {
"_name_": "contact_email",
"title": "contact_email",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "physical_location",
"title": "physical_location",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"city",
"state",
"zip",
"country",
"contact_name",
"contact_phone_number",
"contact_email"
]
},
"primary_use_case": {
"_name_": "primary_use_case",
"title": "primary_use_case",
"_required_": false,
"type": "string"
},
"other_primary_use_case": {
"_name_": "other_primary_use_case",
"title": "other_primary_use_case",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "customer_information_update",
"title": "customer_information_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"company",
"administrative_user",
"technical_user",
"reseller",
"physical_location",
"primary_use_case",
"other_primary_use_case"
]
}
|
Updates customer information. |
tunable.create
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
],
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string",
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string",
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "tunable_create",
"title": "tunable_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
],
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string",
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string",
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"orig_value": {
"_name_": "orig_value",
"title": "orig_value",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "tunable_create_returns",
"title": "tunable_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs",
"id",
"orig_value"
]
}
|
Create a tunable. If If If If |
tunable.delete
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete Tunable of |
tunable.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
]
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"orig_value": {
"_name_": "orig_value",
"title": "orig_value",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "tunable_entry",
"title": "tunable_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs",
"id",
"orig_value"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
tunable.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
]
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"orig_value": {
"_name_": "orig_value",
"title": "orig_value",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "tunable_entry",
"title": "tunable_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs",
"id",
"orig_value"
]
}
]
},
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
]
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"orig_value": {
"_name_": "orig_value",
"title": "orig_value",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "tunable_entry",
"title": "tunable_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs",
"id",
"orig_value"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
]
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"orig_value": {
"_name_": "orig_value",
"title": "orig_value",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "tunable_entry",
"title": "tunable_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs",
"id",
"orig_value"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
tunable.tunable_type_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"SYSCTL": {
"_name_": "SYSCTL",
"title": "SYSCTL",
"_required_": false,
"type": "string",
"enum": [
"SYSCTL"
]
},
"UDEV": {
"_name_": "UDEV",
"title": "UDEV",
"_required_": false,
"type": "string",
"enum": [
"UDEV"
]
},
"ZFS": {
"_name_": "ZFS",
"title": "ZFS",
"_required_": false,
"type": "string",
"enum": [
"ZFS"
]
}
},
"additionalProperties": false,
"_name_": "tunable_type_choices",
"title": "tunable_type_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"SYSCTL",
"UDEV",
"ZFS"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Retrieve the supported tunable types that can be changed. |
tunable.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update Tunable of `id`.\nCreate a tunable."
}
{
"type": "object",
"properties": {
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string",
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "tunable_update",
"title": "tunable_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"value",
"comment",
"enabled",
"update_initramfs"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
],
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string",
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string",
"description": "If `type` is `SYSCTL` then `var` is a sysctl name (e.g. `kernel.watchdog`) and `value` is its corresponding\nvalue (e.g. `0`).\nIf `type` is `UDEV` then `var` is an udev rules file name (e.g. `10-disable-usb`, `.rules` suffix will be\nappended automatically) and `value` is its contents (e.g. `BUS==\"usb\", OPTIONS+=\"ignore_device\"`).\nIf `type` is `ZFS` then `var` is a ZFS kernel module parameter name (e.g. `zfs_dirty_data_max_max`) and `value`\nis its value (e.g. `783091712`)."
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update Tunable of `id`.\nCreate a tunable."
},
"orig_value": {
"_name_": "orig_value",
"title": "orig_value",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "tunable_update_returns",
"title": "tunable_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs",
"id",
"orig_value"
]
}
|
Update Tunable of |
update.check_available |
---|
Arguments:
{
"type": "object",
"properties": {
"train": {
"_name_": "train",
"title": "train",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "update-check-available",
"title": "update-check-available",
"default": {},
"_required_": false,
"_attrs_order_": [
"train"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Checks if there is an update available from update server. status: - REBOOT_REQUIRED: an update has already been applied - AVAILABLE: an update is available - UNAVAILABLE: no update available - HA_UNAVAILABLE: HA is non-functional |
Check available update using default train:
|
update.download
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Download updates using selected train. |
update.file
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"resume": {
"type": "boolean",
"_name_": "resume",
"title": "resume",
"default": false,
"_required_": false,
"description": "`resume` should be set to `true` if a previous call to this method returned a `CallError` with `errno=EAGAIN`\nmeaning that an upgrade can be performed with a warning and that warning is accepted. In that case, re-uploading\nthe file is not necessary."
},
"destination": {
"_name_": "destination",
"title": "destination",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "updatefile",
"title": "updatefile",
"default": {},
"_required_": false,
"_attrs_order_": [
"resume",
"destination"
]
}
|
Updates the system using the uploaded .tar file.
Use null |
update.get_auto_download |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns if update auto-download is enabled. |
update.get_pending |
---|
Arguments:
{
"_name_": "path",
"title": "path",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Gets a list of packages already downloaded and ready to be applied. Each entry of the lists consists of type of operation and name of it, e.g. { "operation": "upgrade", "name": "baseos-11.0 -> baseos-11.1" } |
update.get_trains |
---|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns available trains dict and the currently configured train as well as the train of currently booted environment. |
update.manual
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string",
"description": "`path` must be the absolute path to the update file."
}
{
"type": "object",
"properties": {
"dataset_name": {
"_name_": "dataset_name",
"title": "dataset_name",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"resume": {
"type": "boolean",
"_name_": "resume",
"title": "resume",
"default": false,
"_required_": false
},
"cleanup": {
"type": "boolean",
"_name_": "cleanup",
"title": "cleanup",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"dataset_name",
"resume",
"cleanup"
]
}
|
Update the system using a manual update file.
If |
update.set_auto_download |
---|
Arguments:
{
"type": "boolean",
"_name_": "autocheck",
"title": "autocheck",
"_required_": false
}
|
Sets if update auto-download is enabled. |
update.set_train |
---|
Arguments:
{
"_name_": "train",
"title": "train",
"_required_": false,
"type": "string"
}
|
Set an update train to be used by default in updates. |
update.update
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"dataset_name": {
"_name_": "dataset_name",
"title": "dataset_name",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"resume": {
"type": "boolean",
"_name_": "resume",
"title": "resume",
"default": false,
"_required_": false
},
"train": {
"_name_": "train",
"title": "train",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"reboot": {
"type": "boolean",
"_name_": "reboot",
"title": "reboot",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "update",
"title": "update",
"default": {},
"_required_": false,
"_attrs_order_": [
"dataset_name",
"resume",
"train",
"reboot"
]
}
|
Downloads (if not already in cache) and apply an update.
|
ups.config |
---|
Return Arguments:
{
"type": "object",
"properties": {
"powerdown": {
"type": "boolean",
"_name_": "powerdown",
"title": "powerdown",
"_required_": true
},
"rmonitor": {
"type": "boolean",
"_name_": "rmonitor",
"title": "rmonitor",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"nocommwarntime": {
"type": [
"integer",
"null"
],
"_name_": "nocommwarntime",
"title": "nocommwarntime",
"_required_": true
},
"remoteport": {
"type": "integer",
"_name_": "remoteport",
"title": "remoteport",
"_required_": true
},
"shutdowntimer": {
"type": "integer",
"_name_": "shutdowntimer",
"title": "shutdowntimer",
"_required_": true
},
"hostsync": {
"type": "integer",
"_name_": "hostsync",
"title": "hostsync",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": "string"
},
"extrausers": {
"_name_": "extrausers",
"title": "extrausers",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": true,
"type": "string",
"enum": [
"MASTER",
"SLAVE"
]
},
"monpwd": {
"_name_": "monpwd",
"title": "monpwd",
"_required_": true,
"type": "string"
},
"monuser": {
"_name_": "monuser",
"title": "monuser",
"_required_": true,
"type": "string"
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"optionsupsd": {
"_name_": "optionsupsd",
"title": "optionsupsd",
"_required_": true,
"type": "string"
},
"port": {
"_name_": "port",
"title": "port",
"_required_": true,
"type": "string"
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"_required_": true,
"type": "string"
},
"shutdown": {
"_name_": "shutdown",
"title": "shutdown",
"_required_": true,
"type": "string",
"enum": [
"LOWBATT",
"BATT"
]
},
"shutdowncmd": {
"_name_": "shutdowncmd",
"title": "shutdowncmd",
"_required_": true,
"type": [
"string",
"null"
]
},
"complete_identifier": {
"_name_": "complete_identifier",
"title": "complete_identifier",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ups_entry",
"title": "ups_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"powerdown",
"rmonitor",
"id",
"nocommwarntime",
"remoteport",
"shutdowntimer",
"hostsync",
"description",
"driver",
"extrausers",
"identifier",
"mode",
"monpwd",
"monuser",
"options",
"optionsupsd",
"port",
"remotehost",
"shutdown",
"shutdowncmd",
"complete_identifier"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
ups.driver_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "driver_choices",
"title": "driver_choices",
"description": "\n\nExample(s):\n```\n{\n \"blazer_ser$CPM-800\": \"WinPower ups 2 CPM-800 (blazer_ser)\"\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns choices of UPS drivers supported by the system. |
ups.port_choices |
---|
Return Arguments:
{
"_name_": "port_choices",
"title": "port_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "port_choice",
"title": "port_choice",
"_required_": false,
"type": "string"
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
ups.update |
---|
Arguments:
{
"type": "object",
"properties": {
"powerdown": {
"type": "boolean",
"_name_": "powerdown",
"title": "powerdown",
"_required_": true,
"description": "`powerdown` when enabled, sets UPS to power off after shutting down the system."
},
"rmonitor": {
"type": "boolean",
"_name_": "rmonitor",
"title": "rmonitor",
"_required_": true
},
"nocommwarntime": {
"type": [
"integer",
"null"
],
"_name_": "nocommwarntime",
"title": "nocommwarntime",
"_required_": true,
"description": "`nocommwarntime` is a value in seconds which makes UPS Service wait the specified seconds before alerting that\nthe Service cannot reach configured UPS."
},
"remoteport": {
"type": "integer",
"_name_": "remoteport",
"title": "remoteport",
"_required_": true
},
"shutdowntimer": {
"type": "integer",
"_name_": "shutdowntimer",
"title": "shutdowntimer",
"_required_": true,
"description": "`shutdowntimer` is a value in seconds which tells the Service to wait specified seconds for the UPS before\ninitiating a shutdown. This only applies when `shutdown` is set to \"BATT\"."
},
"hostsync": {
"type": "integer",
"_name_": "hostsync",
"title": "hostsync",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": "string"
},
"extrausers": {
"_name_": "extrausers",
"title": "extrausers",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": true,
"type": "string",
"enum": [
"MASTER",
"SLAVE"
]
},
"monpwd": {
"_name_": "monpwd",
"title": "monpwd",
"_required_": true,
"type": "string"
},
"monuser": {
"_name_": "monuser",
"title": "monuser",
"_required_": true,
"type": "string"
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"optionsupsd": {
"_name_": "optionsupsd",
"title": "optionsupsd",
"_required_": true,
"type": "string"
},
"port": {
"_name_": "port",
"title": "port",
"_required_": true,
"type": "string"
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"_required_": true,
"type": "string"
},
"shutdown": {
"_name_": "shutdown",
"title": "shutdown",
"_required_": true,
"type": "string",
"enum": [
"LOWBATT",
"BATT"
],
"description": "`shutdowntimer` is a value in seconds which tells the Service to wait specified seconds for the UPS before\ninitiating a shutdown. This only applies when `shutdown` is set to \"BATT\"."
},
"shutdowncmd": {
"_name_": "shutdowncmd",
"title": "shutdowncmd",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "ups_update",
"title": "ups_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"powerdown",
"rmonitor",
"nocommwarntime",
"remoteport",
"shutdowntimer",
"hostsync",
"description",
"driver",
"extrausers",
"identifier",
"mode",
"monpwd",
"monuser",
"options",
"optionsupsd",
"port",
"remotehost",
"shutdown",
"shutdowncmd"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"powerdown": {
"type": "boolean",
"_name_": "powerdown",
"title": "powerdown",
"_required_": true,
"description": "`powerdown` when enabled, sets UPS to power off after shutting down the system."
},
"rmonitor": {
"type": "boolean",
"_name_": "rmonitor",
"title": "rmonitor",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"nocommwarntime": {
"type": [
"integer",
"null"
],
"_name_": "nocommwarntime",
"title": "nocommwarntime",
"_required_": true,
"description": "`nocommwarntime` is a value in seconds which makes UPS Service wait the specified seconds before alerting that\nthe Service cannot reach configured UPS."
},
"remoteport": {
"type": "integer",
"_name_": "remoteport",
"title": "remoteport",
"_required_": true
},
"shutdowntimer": {
"type": "integer",
"_name_": "shutdowntimer",
"title": "shutdowntimer",
"_required_": true,
"description": "`shutdowntimer` is a value in seconds which tells the Service to wait specified seconds for the UPS before\ninitiating a shutdown. This only applies when `shutdown` is set to \"BATT\"."
},
"hostsync": {
"type": "integer",
"_name_": "hostsync",
"title": "hostsync",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": "string"
},
"extrausers": {
"_name_": "extrausers",
"title": "extrausers",
"_required_": true,
"type": "string"
},
"identifier": {
"_name_": "identifier",
"title": "identifier",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": true,
"type": "string",
"enum": [
"MASTER",
"SLAVE"
]
},
"monpwd": {
"_name_": "monpwd",
"title": "monpwd",
"_required_": true,
"type": "string"
},
"monuser": {
"_name_": "monuser",
"title": "monuser",
"_required_": true,
"type": "string"
},
"options": {
"_name_": "options",
"title": "options",
"_required_": true,
"type": "string"
},
"optionsupsd": {
"_name_": "optionsupsd",
"title": "optionsupsd",
"_required_": true,
"type": "string"
},
"port": {
"_name_": "port",
"title": "port",
"_required_": true,
"type": "string"
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"_required_": true,
"type": "string"
},
"shutdown": {
"_name_": "shutdown",
"title": "shutdown",
"_required_": true,
"type": "string",
"enum": [
"LOWBATT",
"BATT"
],
"description": "`shutdowntimer` is a value in seconds which tells the Service to wait specified seconds for the UPS before\ninitiating a shutdown. This only applies when `shutdown` is set to \"BATT\"."
},
"shutdowncmd": {
"_name_": "shutdowncmd",
"title": "shutdowncmd",
"_required_": true,
"type": [
"string",
"null"
]
},
"complete_identifier": {
"_name_": "complete_identifier",
"title": "complete_identifier",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ups_update_returns",
"title": "ups_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"powerdown",
"rmonitor",
"id",
"nocommwarntime",
"remoteport",
"shutdowntimer",
"hostsync",
"description",
"driver",
"extrausers",
"identifier",
"mode",
"monpwd",
"monuser",
"options",
"optionsupsd",
"port",
"remotehost",
"shutdown",
"shutdowncmd",
"complete_identifier"
]
}
|
Update UPS Service Configuration.
|
user.create |
---|
Arguments:
{
"additionalProperties": false,
"properties": {
"uid": {
"anyOf": [
{
"maximum": 90000000,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "uid",
"_name_": "uid",
"_required_": false
},
"username": {
"title": "username",
"type": "string",
"_name_": "username",
"_required_": true
},
"home": {
"default": "/var/empty",
"minLength": 1,
"title": "home",
"type": "string",
"_name_": "home",
"_required_": false
},
"shell": {
"default": "/usr/bin/zsh",
"minLength": 1,
"title": "shell",
"type": "string",
"_name_": "shell",
"_required_": false
},
"full_name": {
"minLength": 1,
"title": "full_name",
"type": "string",
"_name_": "full_name",
"_required_": true
},
"smb": {
"default": true,
"title": "smb",
"type": "boolean",
"_name_": "smb",
"_required_": false
},
"group": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "group",
"_name_": "group",
"_required_": false
},
"groups": {
"default": [],
"items": [
{
"type": "integer"
}
],
"title": "groups",
"type": "array",
"_name_": "groups",
"_required_": false
},
"password_disabled": {
"default": false,
"title": "password_disabled",
"type": "boolean",
"_name_": "password_disabled",
"_required_": false
},
"ssh_password_enabled": {
"default": false,
"title": "ssh_password_enabled",
"type": "boolean",
"_name_": "ssh_password_enabled",
"_required_": false
},
"sshpubkey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "sshpubkey",
"_name_": "sshpubkey",
"_required_": false
},
"locked": {
"default": false,
"title": "locked",
"type": "boolean",
"_name_": "locked",
"_required_": false
},
"sudo_commands": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands",
"type": "array",
"_name_": "sudo_commands",
"_required_": false
},
"sudo_commands_nopasswd": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands_nopasswd",
"type": "array",
"_name_": "sudo_commands_nopasswd",
"_required_": false
},
"email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "email",
"_name_": "email",
"_required_": false
},
"group_create": {
"default": false,
"title": "group_create",
"type": "boolean",
"_name_": "group_create",
"_required_": false
},
"home_create": {
"default": false,
"title": "home_create",
"type": "boolean",
"_name_": "home_create",
"_required_": false
},
"home_mode": {
"default": "700",
"title": "home_mode",
"type": "string",
"_name_": "home_mode",
"_required_": false
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "password",
"_name_": "password",
"_required_": false
}
},
"required": [
"username",
"full_name"
],
"title": "user_create",
"type": "object",
"_name_": "user_create",
"_required_": true,
"_attrs_order_": [
"uid",
"username",
"home",
"shell",
"full_name",
"smb",
"group",
"groups",
"password_disabled",
"ssh_password_enabled",
"sshpubkey",
"locked",
"sudo_commands",
"sudo_commands_nopasswd",
"email",
"group_create",
"home_create",
"home_mode",
"password"
]
}
|
Return Arguments:
{
"title": "result",
"type": "integer",
"_name_": "result",
"_required_": true
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_WRITE |
Create a new user. |
user.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Delete user `id`."
}
{
"type": "object",
"properties": {
"delete_group": {
"type": "boolean",
"_name_": "delete_group",
"title": "delete_group",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"delete_group"
]
}
|
Return Arguments:
{
"type": "integer",
"_name_": "primary_key",
"title": "primary_key",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_WRITE |
Delete user The |
user.get_instance |
---|
Arguments:
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
}
{
"allOf": [
{
"additionalProperties": false,
"properties": {
"relationships": {
"default": true,
"title": "relationships",
"type": "boolean",
"_name_": "relationships",
"_required_": false
},
"extend": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend",
"_name_": "extend",
"_required_": false
},
"extend_context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend_context",
"_name_": "extend_context",
"_required_": false
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "prefix",
"_name_": "prefix",
"_required_": false
},
"extra": {
"default": {},
"title": "extra",
"type": "object",
"_name_": "extra",
"_required_": false
},
"order_by": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "order_by",
"type": "array",
"_name_": "order_by",
"_required_": false
},
"select": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "select",
"type": "array",
"_name_": "select",
"_required_": false
},
"count": {
"default": false,
"title": "count",
"type": "boolean",
"_name_": "count",
"_required_": false
},
"get": {
"default": false,
"title": "get",
"type": "boolean",
"_name_": "get",
"_required_": false
},
"offset": {
"default": 0,
"title": "offset",
"type": "integer",
"_name_": "offset",
"_required_": false
},
"limit": {
"default": 0,
"title": "limit",
"type": "integer",
"_name_": "limit",
"_required_": false
},
"force_sql_filters": {
"default": false,
"title": "force_sql_filters",
"type": "boolean",
"_name_": "force_sql_filters",
"_required_": false
}
},
"title": "QueryOptions",
"type": "object",
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
],
"default": {},
"title": "options",
"_name_": "options",
"_required_": false
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"uid": {
"title": "uid",
"type": "integer",
"_name_": "uid",
"_required_": true
},
"username": {
"title": "username",
"type": "string",
"_name_": "username",
"_required_": true
},
"unixhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "unixhash",
"_name_": "unixhash",
"_required_": true
},
"smbhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "smbhash",
"_name_": "smbhash",
"_required_": true
},
"home": {
"default": "/var/empty",
"minLength": 1,
"title": "home",
"type": "string",
"_name_": "home",
"_required_": false
},
"shell": {
"default": "/usr/bin/zsh",
"minLength": 1,
"title": "shell",
"type": "string",
"_name_": "shell",
"_required_": false
},
"full_name": {
"title": "full_name",
"type": "string",
"_name_": "full_name",
"_required_": true
},
"builtin": {
"title": "builtin",
"type": "boolean",
"_name_": "builtin",
"_required_": true
},
"smb": {
"default": true,
"title": "smb",
"type": "boolean",
"_name_": "smb",
"_required_": false
},
"group": {
"title": "group",
"type": "object",
"_name_": "group",
"_required_": true
},
"groups": {
"default": [],
"items": [
{
"type": "integer"
}
],
"title": "groups",
"type": "array",
"_name_": "groups",
"_required_": false
},
"password_disabled": {
"default": false,
"title": "password_disabled",
"type": "boolean",
"_name_": "password_disabled",
"_required_": false
},
"ssh_password_enabled": {
"default": false,
"title": "ssh_password_enabled",
"type": "boolean",
"_name_": "ssh_password_enabled",
"_required_": false
},
"sshpubkey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "sshpubkey",
"_name_": "sshpubkey",
"_required_": false
},
"locked": {
"default": false,
"title": "locked",
"type": "boolean",
"_name_": "locked",
"_required_": false
},
"sudo_commands": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands",
"type": "array",
"_name_": "sudo_commands",
"_required_": false
},
"sudo_commands_nopasswd": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands_nopasswd",
"type": "array",
"_name_": "sudo_commands_nopasswd",
"_required_": false
},
"email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "email",
"_name_": "email",
"_required_": false
},
"id_type_both": {
"title": "id_type_both",
"type": "boolean",
"_name_": "id_type_both",
"_required_": true
},
"local": {
"title": "local",
"type": "boolean",
"_name_": "local",
"_required_": true
},
"immutable": {
"title": "immutable",
"type": "boolean",
"_name_": "immutable",
"_required_": true
},
"twofactor_auth_configured": {
"title": "twofactor_auth_configured",
"type": "boolean",
"_name_": "twofactor_auth_configured",
"_required_": true
},
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "sid",
"_name_": "sid",
"_required_": true
},
"roles": {
"items": [
{
"type": "string"
}
],
"title": "roles",
"type": "array",
"_name_": "roles",
"_required_": true
}
},
"required": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"full_name",
"builtin",
"group",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"home",
"shell",
"full_name",
"builtin",
"smb",
"group",
"groups",
"password_disabled",
"ssh_password_enabled",
"sshpubkey",
"locked",
"sudo_commands",
"sudo_commands_nopasswd",
"email",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
]
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
user.get_next_uid |
---|
Return Arguments:
{
"type": "integer",
"_name_": "next_available_uid",
"title": "next_available_uid",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Get the next available/free uid. |
user.get_user_obj |
---|
Arguments:
{
"type": "object",
"properties": {
"username": {
"_name_": "username",
"title": "username",
"default": null,
"_required_": false,
"type": "string"
},
"uid": {
"type": "integer",
"_name_": "uid",
"title": "uid",
"default": null,
"_required_": false
},
"get_groups": {
"type": "boolean",
"_name_": "get_groups",
"title": "get_groups",
"default": false,
"_required_": false,
"description": "`get_groups` - retrieve group list for the specified user.\n`grouplist` - optional list of group ids for groups of which this account is a member. If `get_groups`\nis not specified, this value will be null."
},
"sid_info": {
"type": "boolean",
"_name_": "sid_info",
"title": "sid_info",
"default": false,
"_required_": false,
"description": "`sid_info` - retrieve SID and domain information for the user\n`sid` - optional SID value for the account that is present if `sid_info` is specified in payload."
}
},
"additionalProperties": false,
"_name_": "get_user_obj",
"title": "get_user_obj",
"default": {},
"_required_": false,
"_attrs_order_": [
"username",
"uid",
"get_groups",
"sid_info"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"pw_name": {
"_name_": "pw_name",
"title": "pw_name",
"_required_": false,
"type": "string",
"description": "`pw_name` - name of the user"
},
"pw_gecos": {
"_name_": "pw_gecos",
"title": "pw_gecos",
"_required_": false,
"type": "string",
"description": "`pw_gecos` - full username or comment field"
},
"pw_dir": {
"_name_": "pw_dir",
"title": "pw_dir",
"_required_": false,
"type": "string",
"description": "`pw_dir` - user home directory"
},
"pw_shell": {
"_name_": "pw_shell",
"title": "pw_shell",
"_required_": false,
"type": "string",
"description": "`pw_shell` - user command line interpreter"
},
"pw_uid": {
"type": "integer",
"_name_": "pw_uid",
"title": "pw_uid",
"_required_": false,
"description": "`pw_uid` - numerical user id of the user"
},
"pw_gid": {
"type": "integer",
"_name_": "pw_gid",
"title": "pw_gid",
"_required_": false,
"description": "`pw_gid` - numerical group id for the user's primary group"
},
"grouplist": {
"_name_": "grouplist",
"title": "grouplist",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`grouplist` - optional list of group ids for groups of which this account is a member. If `get_groups`\nis not specified, this value will be null."
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
],
"description": "`sid` - optional SID value for the account that is present if `sid_info` is specified in payload."
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"ACTIVEDIRECTORY",
"LDAP"
]
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false,
"description": "`local` - boolean value indicating whether the account is local to TrueNAS or provided by\na directory service."
}
},
"additionalProperties": false,
"_name_": "user_information",
"title": "user_information",
"default": {},
"_required_": false,
"_attrs_order_": [
"pw_name",
"pw_gecos",
"pw_dir",
"pw_shell",
"pw_uid",
"pw_gid",
"grouplist",
"sid",
"source",
"local"
]
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Returns dictionary containing information from struct passwd for the user specified by either the username or uid. Bypasses user cache. Supports the following optional parameters:
NOTE: results will not include nested groups for Active Directory users
Returns object with following keys:
|
user.has_local_administrator_set_up |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "has_local_administrator_set_up",
"title": "has_local_administrator_set_up",
"_required_": false
}
|
Return whether a local administrator with a valid password exists. This is used when the system is installed without a password and must be set on first use/login. |
user.has_root_password |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "has_root_password",
"title": "has_root_password",
"_required_": false
}
|
Deprecated method. Use |
user.provisioning_uri |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"_name_": "provisioning_uri",
"title": "Provisioning URI",
"_required_": false,
"type": "string"
}
|
Returns the provisioning URI for the OTP for |
user.query |
---|
Arguments:
{
"default": [],
"items": [
{}
],
"title": "filters",
"type": "array",
"_name_": "filters",
"_required_": false
}
{
"allOf": [
{
"additionalProperties": false,
"properties": {
"relationships": {
"default": true,
"title": "relationships",
"type": "boolean",
"_name_": "relationships",
"_required_": false
},
"extend": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend",
"_name_": "extend",
"_required_": false
},
"extend_context": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "extend_context",
"_name_": "extend_context",
"_required_": false
},
"prefix": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "prefix",
"_name_": "prefix",
"_required_": false
},
"extra": {
"default": {},
"title": "extra",
"type": "object",
"_name_": "extra",
"_required_": false
},
"order_by": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "order_by",
"type": "array",
"_name_": "order_by",
"_required_": false
},
"select": {
"default": [],
"items": [
{
"type": "string"
}
],
"title": "select",
"type": "array",
"_name_": "select",
"_required_": false
},
"count": {
"default": false,
"title": "count",
"type": "boolean",
"_name_": "count",
"_required_": false
},
"get": {
"default": false,
"title": "get",
"type": "boolean",
"_name_": "get",
"_required_": false
},
"offset": {
"default": 0,
"title": "offset",
"type": "integer",
"_name_": "offset",
"_required_": false
},
"limit": {
"default": 0,
"title": "limit",
"type": "integer",
"_name_": "limit",
"_required_": false
},
"force_sql_filters": {
"default": false,
"title": "force_sql_filters",
"type": "boolean",
"_name_": "force_sql_filters",
"_required_": false
}
},
"title": "QueryOptions",
"type": "object",
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
],
"default": {
"relationships": true,
"extend": null,
"extend_context": null,
"prefix": null,
"extra": {},
"order_by": [],
"select": [],
"count": false,
"get": false,
"offset": 0,
"limit": 0,
"force_sql_filters": false
},
"title": "options",
"_name_": "options",
"_required_": false
}
|
Return Arguments:
{
"anyOf": [
{
"items": [
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"uid": {
"title": "uid",
"type": "integer",
"_name_": "uid",
"_required_": true
},
"username": {
"title": "username",
"type": "string",
"_name_": "username",
"_required_": true
},
"unixhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "unixhash",
"_name_": "unixhash",
"_required_": true
},
"smbhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "smbhash",
"_name_": "smbhash",
"_required_": true
},
"home": {
"default": "/var/empty",
"minLength": 1,
"title": "home",
"type": "string",
"_name_": "home",
"_required_": false
},
"shell": {
"default": "/usr/bin/zsh",
"minLength": 1,
"title": "shell",
"type": "string",
"_name_": "shell",
"_required_": false
},
"full_name": {
"title": "full_name",
"type": "string",
"_name_": "full_name",
"_required_": true
},
"builtin": {
"title": "builtin",
"type": "boolean",
"_name_": "builtin",
"_required_": true
},
"smb": {
"default": true,
"title": "smb",
"type": "boolean",
"_name_": "smb",
"_required_": false
},
"group": {
"title": "group",
"type": "object",
"_name_": "group",
"_required_": true
},
"groups": {
"default": [],
"items": [
{
"type": "integer"
}
],
"title": "groups",
"type": "array",
"_name_": "groups",
"_required_": false
},
"password_disabled": {
"default": false,
"title": "password_disabled",
"type": "boolean",
"_name_": "password_disabled",
"_required_": false
},
"ssh_password_enabled": {
"default": false,
"title": "ssh_password_enabled",
"type": "boolean",
"_name_": "ssh_password_enabled",
"_required_": false
},
"sshpubkey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "sshpubkey",
"_name_": "sshpubkey",
"_required_": false
},
"locked": {
"default": false,
"title": "locked",
"type": "boolean",
"_name_": "locked",
"_required_": false
},
"sudo_commands": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands",
"type": "array",
"_name_": "sudo_commands",
"_required_": false
},
"sudo_commands_nopasswd": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands_nopasswd",
"type": "array",
"_name_": "sudo_commands_nopasswd",
"_required_": false
},
"email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "email",
"_name_": "email",
"_required_": false
},
"id_type_both": {
"title": "id_type_both",
"type": "boolean",
"_name_": "id_type_both",
"_required_": true
},
"local": {
"title": "local",
"type": "boolean",
"_name_": "local",
"_required_": true
},
"immutable": {
"title": "immutable",
"type": "boolean",
"_name_": "immutable",
"_required_": true
},
"twofactor_auth_configured": {
"title": "twofactor_auth_configured",
"type": "boolean",
"_name_": "twofactor_auth_configured",
"_required_": true
},
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "sid",
"_name_": "sid",
"_required_": true
},
"roles": {
"items": [
{
"type": "string"
}
],
"title": "roles",
"type": "array",
"_name_": "roles",
"_required_": true
}
},
"required": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"full_name",
"builtin",
"group",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
],
"title": "UserEntry",
"type": "object",
"_attrs_order_": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"home",
"shell",
"full_name",
"builtin",
"smb",
"group",
"groups",
"password_disabled",
"ssh_password_enabled",
"sshpubkey",
"locked",
"sudo_commands",
"sudo_commands_nopasswd",
"email",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
]
}
],
"type": "array"
},
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"uid": {
"title": "uid",
"type": "integer",
"_name_": "uid",
"_required_": true
},
"username": {
"title": "username",
"type": "string",
"_name_": "username",
"_required_": true
},
"unixhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "unixhash",
"_name_": "unixhash",
"_required_": true
},
"smbhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "smbhash",
"_name_": "smbhash",
"_required_": true
},
"home": {
"default": "/var/empty",
"minLength": 1,
"title": "home",
"type": "string",
"_name_": "home",
"_required_": false
},
"shell": {
"default": "/usr/bin/zsh",
"minLength": 1,
"title": "shell",
"type": "string",
"_name_": "shell",
"_required_": false
},
"full_name": {
"title": "full_name",
"type": "string",
"_name_": "full_name",
"_required_": true
},
"builtin": {
"title": "builtin",
"type": "boolean",
"_name_": "builtin",
"_required_": true
},
"smb": {
"default": true,
"title": "smb",
"type": "boolean",
"_name_": "smb",
"_required_": false
},
"group": {
"title": "group",
"type": "object",
"_name_": "group",
"_required_": true
},
"groups": {
"default": [],
"items": [
{
"type": "integer"
}
],
"title": "groups",
"type": "array",
"_name_": "groups",
"_required_": false
},
"password_disabled": {
"default": false,
"title": "password_disabled",
"type": "boolean",
"_name_": "password_disabled",
"_required_": false
},
"ssh_password_enabled": {
"default": false,
"title": "ssh_password_enabled",
"type": "boolean",
"_name_": "ssh_password_enabled",
"_required_": false
},
"sshpubkey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "sshpubkey",
"_name_": "sshpubkey",
"_required_": false
},
"locked": {
"default": false,
"title": "locked",
"type": "boolean",
"_name_": "locked",
"_required_": false
},
"sudo_commands": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands",
"type": "array",
"_name_": "sudo_commands",
"_required_": false
},
"sudo_commands_nopasswd": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands_nopasswd",
"type": "array",
"_name_": "sudo_commands_nopasswd",
"_required_": false
},
"email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "email",
"_name_": "email",
"_required_": false
},
"id_type_both": {
"title": "id_type_both",
"type": "boolean",
"_name_": "id_type_both",
"_required_": true
},
"local": {
"title": "local",
"type": "boolean",
"_name_": "local",
"_required_": true
},
"immutable": {
"title": "immutable",
"type": "boolean",
"_name_": "immutable",
"_required_": true
},
"twofactor_auth_configured": {
"title": "twofactor_auth_configured",
"type": "boolean",
"_name_": "twofactor_auth_configured",
"_required_": true
},
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "sid",
"_name_": "sid",
"_required_": true
},
"roles": {
"items": [
{
"type": "string"
}
],
"title": "roles",
"type": "array",
"_name_": "roles",
"_required_": true
}
},
"required": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"full_name",
"builtin",
"group",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
],
"title": "UserEntry",
"type": "object",
"_attrs_order_": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"home",
"shell",
"full_name",
"builtin",
"smb",
"group",
"groups",
"password_disabled",
"ssh_password_enabled",
"sshpubkey",
"locked",
"sudo_commands",
"sudo_commands_nopasswd",
"email",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
]
},
{
"type": "integer"
}
],
"title": "result",
"_name_": "result",
"_required_": true
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Query users with If users provided by Active Directory or LDAP are not desired, then "local", "=", True should be added to filters. |
user.renew_2fa_secret |
---|
Arguments:
{
"title": "username",
"type": "string",
"_name_": "username",
"_required_": true
}
{
"additionalProperties": false,
"properties": {
"otp_digits": {
"maximum": 8,
"minimum": 6,
"title": "otp_digits",
"type": "integer",
"_name_": "otp_digits",
"_required_": false
},
"interval": {
"minimum": 5,
"title": "interval",
"type": "integer",
"_name_": "interval",
"_required_": false
}
},
"title": "twofactor_options",
"type": "object",
"_name_": "twofactor_options",
"_required_": true,
"_attrs_order_": [
"otp_digits",
"interval"
]
}
|
Return Arguments:
{
"additionalProperties": false,
"properties": {
"id": {
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
"uid": {
"title": "uid",
"type": "integer",
"_name_": "uid",
"_required_": true
},
"username": {
"title": "username",
"type": "string",
"_name_": "username",
"_required_": true
},
"unixhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "unixhash",
"_name_": "unixhash",
"_required_": true
},
"smbhash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "smbhash",
"_name_": "smbhash",
"_required_": true
},
"home": {
"default": "/var/empty",
"minLength": 1,
"title": "home",
"type": "string",
"_name_": "home",
"_required_": false
},
"shell": {
"default": "/usr/bin/zsh",
"minLength": 1,
"title": "shell",
"type": "string",
"_name_": "shell",
"_required_": false
},
"full_name": {
"title": "full_name",
"type": "string",
"_name_": "full_name",
"_required_": true
},
"builtin": {
"title": "builtin",
"type": "boolean",
"_name_": "builtin",
"_required_": true
},
"smb": {
"default": true,
"title": "smb",
"type": "boolean",
"_name_": "smb",
"_required_": false
},
"group": {
"title": "group",
"type": "object",
"_name_": "group",
"_required_": true
},
"groups": {
"default": [],
"items": [
{
"type": "integer"
}
],
"title": "groups",
"type": "array",
"_name_": "groups",
"_required_": false
},
"password_disabled": {
"default": false,
"title": "password_disabled",
"type": "boolean",
"_name_": "password_disabled",
"_required_": false
},
"ssh_password_enabled": {
"default": false,
"title": "ssh_password_enabled",
"type": "boolean",
"_name_": "ssh_password_enabled",
"_required_": false
},
"sshpubkey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "sshpubkey",
"_name_": "sshpubkey",
"_required_": false
},
"locked": {
"default": false,
"title": "locked",
"type": "boolean",
"_name_": "locked",
"_required_": false
},
"sudo_commands": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands",
"type": "array",
"_name_": "sudo_commands",
"_required_": false
},
"sudo_commands_nopasswd": {
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands_nopasswd",
"type": "array",
"_name_": "sudo_commands_nopasswd",
"_required_": false
},
"email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "email",
"_name_": "email",
"_required_": false
},
"id_type_both": {
"title": "id_type_both",
"type": "boolean",
"_name_": "id_type_both",
"_required_": true
},
"local": {
"title": "local",
"type": "boolean",
"_name_": "local",
"_required_": true
},
"immutable": {
"title": "immutable",
"type": "boolean",
"_name_": "immutable",
"_required_": true
},
"twofactor_auth_configured": {
"title": "twofactor_auth_configured",
"type": "boolean",
"_name_": "twofactor_auth_configured",
"_required_": true
},
"sid": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "sid",
"_name_": "sid",
"_required_": true
},
"roles": {
"items": [
{
"type": "string"
}
],
"title": "roles",
"type": "array",
"_name_": "roles",
"_required_": true
}
},
"required": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"full_name",
"builtin",
"group",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
],
"title": "result",
"type": "object",
"_name_": "result",
"_required_": true,
"_attrs_order_": [
"id",
"uid",
"username",
"unixhash",
"smbhash",
"home",
"shell",
"full_name",
"builtin",
"smb",
"group",
"groups",
"password_disabled",
"ssh_password_enabled",
"sshpubkey",
"locked",
"sudo_commands",
"sudo_commands_nopasswd",
"email",
"id_type_both",
"local",
"immutable",
"twofactor_auth_configured",
"sid",
"roles"
]
}
|
Renew NOTE: This username must match the authenticated username unless authenticated credentials have FULL_ADMIN role. |
user.set_password |
---|
Arguments:
{
"type": "object",
"properties": {
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string",
"description": "Set the password of the specified `username` to the `new_password`\nspecified in payload."
},
"old_password": {
"_name_": "old_password",
"title": "old_password",
"default": null,
"_required_": false,
"type": "string"
},
"new_password": {
"_name_": "new_password",
"title": "new_password",
"_required_": true,
"type": "string",
"description": "Set the password of the specified `username` to the `new_password`\nspecified in payload."
}
},
"additionalProperties": false,
"_name_": "set_password_data",
"title": "set_password_data",
"default": {},
"_required_": false,
"_attrs_order_": [
"username",
"old_password",
"new_password"
]
}
|
Set the password of the specified ValidationErrors will be raised in the following situations: * username does not exist * account is not local to the NAS (Active Directory, LDAP, etc) * account has password authentication disabled * account is locked NOTE: when authenticated session has less than FULL_ADMIN role, password changes will be rejected if the payload does not match the currently-authenticated user. API keys granting access to this endpoint will be able to reset the password of any user. |
user.setup_local_administrator |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string",
"enum": [
"root",
"truenas_admin"
]
}
{
"_name_": "password",
"title": "password",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"ec2": {
"type": "object",
"properties": {
"instance_id": {
"_name_": "instance_id",
"title": "instance_id",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "ec2",
"title": "ec2",
"default": {},
"_required_": false,
"_attrs_order_": [
"instance_id"
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ec2"
]
}
|
Set up local administrator (this method does not require authentication if local administrator is not already set up). |
user.shell_choices |
---|
Arguments:
{
"_name_": "group_ids",
"title": "group_ids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "group_id",
"title": "group_id",
"_required_": false
}
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"shell_path": {
"_name_": "shell_path",
"title": "shell_path",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "shell_info",
"title": "shell_info",
"description": "\n\nExample(s):\n```\n{\n \"/usr/bin/bash\": \"bash\",\n \"/usr/bin/rbash\": \"rbash\",\n \"/usr/bin/dash\": \"dash\",\n \"/usr/bin/sh\": \"sh\",\n \"/usr/bin/zsh\": \"zsh\",\n \"/usr/bin/tmux\": \"tmux\",\n \"/usr/sbin/nologin\": \"nologin\"\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": [
"shell_path"
]
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_READ, ACCOUNT_WRITE, READONLY_ADMIN, SHARING_ADMIN |
Return the available shell choices to be used in
|
user.twofactor_config |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"provisioning_uri": {
"_name_": "provisioning_uri",
"title": "provisioning_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"secret_configured": {
"type": "boolean",
"_name_": "secret_configured",
"title": "secret_configured",
"_required_": false
},
"interval": {
"type": "integer",
"_name_": "interval",
"title": "interval",
"_required_": false
},
"otp_digits": {
"type": "integer",
"_name_": "otp_digits",
"title": "otp_digits",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "user_twofactor_config",
"title": "user_twofactor_config",
"default": {},
"_required_": false,
"_attrs_order_": [
"provisioning_uri",
"secret_configured",
"interval",
"otp_digits"
]
}
|
Returns two-factor authentication configuration settings for specified |
user.unset_2fa_secret |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
|
Unset two-factor authentication secret for |
user.update |
---|
Arguments:
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
}
{
"additionalProperties": false,
"properties": {
"uid": {
"anyOf": [
{
"maximum": 90000000,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "uid",
"_name_": "uid",
"_required_": false
},
"username": {
"title": "username",
"type": "string",
"_name_": "username",
"_required_": false
},
"home": {
"minLength": 1,
"title": "home",
"type": "string",
"_name_": "home",
"_required_": false
},
"shell": {
"minLength": 1,
"title": "shell",
"type": "string",
"_name_": "shell",
"_required_": false
},
"full_name": {
"minLength": 1,
"title": "full_name",
"type": "string",
"_name_": "full_name",
"_required_": false
},
"smb": {
"title": "smb",
"type": "boolean",
"_name_": "smb",
"_required_": false
},
"group": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "group",
"_name_": "group",
"_required_": false
},
"groups": {
"items": [
{
"type": "integer"
}
],
"title": "groups",
"type": "array",
"_name_": "groups",
"_required_": false
},
"password_disabled": {
"title": "password_disabled",
"type": "boolean",
"_name_": "password_disabled",
"_required_": false
},
"ssh_password_enabled": {
"title": "ssh_password_enabled",
"type": "boolean",
"_name_": "ssh_password_enabled",
"_required_": false
},
"sshpubkey": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "sshpubkey",
"_name_": "sshpubkey",
"_required_": false
},
"locked": {
"title": "locked",
"type": "boolean",
"_name_": "locked",
"_required_": false
},
"sudo_commands": {
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands",
"type": "array",
"_name_": "sudo_commands",
"_required_": false
},
"sudo_commands_nopasswd": {
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands_nopasswd",
"type": "array",
"_name_": "sudo_commands_nopasswd",
"_required_": false
},
"email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"title": "email",
"_name_": "email",
"_required_": false
},
"home_create": {
"title": "home_create",
"type": "boolean",
"_name_": "home_create",
"_required_": false
},
"home_mode": {
"title": "home_mode",
"type": "string",
"_name_": "home_mode",
"_required_": false
},
"password": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "password",
"_name_": "password",
"_required_": false
}
},
"title": "user_update",
"type": "object",
"_name_": "user_update",
"_required_": true,
"_attrs_order_": [
"uid",
"username",
"home",
"shell",
"full_name",
"smb",
"group",
"groups",
"password_disabled",
"ssh_password_enabled",
"sshpubkey",
"locked",
"sudo_commands",
"sudo_commands_nopasswd",
"email",
"home_create",
"home_mode",
"password"
]
}
|
Return Arguments:
{
"title": "result",
"type": "integer",
"_name_": "result",
"_required_": true
}
|
This method is accessible to the users granted with the following roles: ACCOUNT_WRITE |
Update attributes of an existing user. |
user.verify_twofactor_token |
---|
Arguments:
{
"_name_": "username",
"title": "username",
"_required_": false,
"type": "string"
}
{
"_name_": "token",
"title": "token",
"_required_": false,
"type": [
"string",
"null"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "token_verified",
"title": "token_verified",
"_required_": false
}
|
Returns boolean true if provided |
vm.bootloader_options |
---|
Return Arguments:
{
"type": "object",
"properties": {
"UEFI": {
"_name_": "UEFI",
"title": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI"
]
},
"UEFI_CSM": {
"_name_": "UEFI_CSM",
"title": "UEFI_CSM",
"_required_": false,
"type": "string",
"enum": [
"Legacy BIOS"
]
}
},
"additionalProperties": false,
"_name_": "bootloader_options",
"title": "bootloader_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"UEFI",
"UEFI_CSM"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Supported motherboard firmware options. |
vm.bootloader_ovmf_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "bootloader_ovmf_choices",
"title": "bootloader_ovmf_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve bootloader ovmf choices |
vm.clone |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Clone the VM `id`."
}
{
"_name_": "name",
"title": "name",
"default": null,
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "clone",
"title": "clone",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Clone the VM
|
vm.cpu_model_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "cpu_model_choices",
"title": "cpu_model_choices",
"description": "\n\nExample(s):\n```\n{\n \"486\": \"486\",\n \"pentium\": \"pentium\"\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve CPU Model choices which can be used with a VM guest to emulate the CPU in the guest. |
vm.create |
---|
Arguments:
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false,
"description": "`hyperv_enlightenments` can be used to enable subset of predefined Hyper-V enlightenments for Windows guests.\nThese enlightenments improve performance and enable otherwise missing features."
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false,
"description": "`hide_from_msr` is a boolean which when set will hide the KVM hypervisor from standard MSR based discovery and\nis useful to enable when doing GPU passthrough."
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false,
"description": "`ensure_display_device` when set ( the default ) will ensure that the guest always has access to a video device.\nFor headless installations like ubuntu server this is required for the guest to operate properly. However\nfor cases where consumer would like to use GPU passthrough and does not want a display device added should set\nthis to `false`."
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false,
"description": "`shutdown_timeout` indicates the time in seconds the system waits for the VM to cleanly shutdown. During system\nshutdown, if the VM hasn't exited after a hardware shutdown signal has been sent by the system within\n`shutdown_timeout` seconds, system initiates poweroff for the VM to stop it."
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`arch_type` refers to architecture type and can be specified for the guest. By default the value is `null` and\nsystem in this case will choose a reasonable default based on host.\n`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "vm_create",
"title": "vm_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false,
"description": "`hyperv_enlightenments` can be used to enable subset of predefined Hyper-V enlightenments for Windows guests.\nThese enlightenments improve performance and enable otherwise missing features."
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false,
"description": "`hide_from_msr` is a boolean which when set will hide the KVM hypervisor from standard MSR based discovery and\nis useful to enable when doing GPU passthrough."
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false,
"description": "`ensure_display_device` when set ( the default ) will ensure that the guest always has access to a video device.\nFor headless installations like ubuntu server this is required for the guest to operate properly. However\nfor cases where consumer would like to use GPU passthrough and does not want a display device added should set\nthis to `false`."
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false,
"description": "`shutdown_timeout` indicates the time in seconds the system waits for the VM to cleanly shutdown. During system\nshutdown, if the VM hasn't exited after a hardware shutdown signal has been sent by the system within\n`shutdown_timeout` seconds, system initiates poweroff for the VM to stop it."
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`arch_type` refers to architecture type and can be specified for the guest. By default the value is `null` and\nsystem in this case will choose a reasonable default based on host.\n`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"status": {
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
},
"display_available": {
"type": "boolean",
"_name_": "display_available",
"title": "display_available",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_create_returns",
"title": "vm_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"devices",
"status",
"display_available",
"id"
]
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Create a Virtual Machine (VM). Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a
separate package. Multiple cores can be configured per CPU by specifying
|
vm.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"zvols": {
"type": "boolean",
"_name_": "zvols",
"title": "zvols",
"default": false,
"_required_": false
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_delete",
"title": "vm_delete",
"default": {},
"_required_": false,
"_attrs_order_": [
"zvols",
"force"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Delete a VM. |
vm.export_disk_image
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"format": {
"_name_": "format",
"title": "format",
"_required_": true,
"type": "string",
"description": "`format` is an required parameter for the exported disk image"
},
"directory": {
"_name_": "directory",
"title": "directory",
"_required_": true,
"type": "string",
"description": "`directory` is an required parameter for the export disk image"
},
"zvol": {
"_name_": "zvol",
"title": "zvol",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "vm_info",
"title": "vm_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"format",
"directory",
"zvol"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "export_disk_image",
"title": "export_disk_image",
"_required_": false
}
|
Exports a zvol to a formatted VM disk image. Utilized qemu-img with the conversion functionality to export a zvol to any supported disk image format, from RAW -> ${OTHER}. The resulting file will be set to inherit the permissions of the target directory. As of this implementation it supports the following {format} options :
|
vm.flags |
---|
Return Arguments:
{
"type": "object",
"properties": {
"intel_vmx": {
"type": "boolean",
"_name_": "intel_vmx",
"title": "intel_vmx",
"_required_": true
},
"unrestricted_guest": {
"type": "boolean",
"_name_": "unrestricted_guest",
"title": "unrestricted_guest",
"_required_": true
},
"amd_rvi": {
"type": "boolean",
"_name_": "amd_rvi",
"title": "amd_rvi",
"_required_": true
},
"amd_asids": {
"type": "boolean",
"_name_": "amd_asids",
"title": "amd_asids",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "cpu_flags",
"title": "cpu_flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"intel_vmx",
"unrestricted_guest",
"amd_rvi",
"amd_asids"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Returns a dictionary with CPU flags for the hypervisor. |
vm.get_available_memory |
---|
Arguments:
{
"type": "boolean",
"_name_": "overcommit",
"title": "overcommit",
"default": false,
"_required_": false,
"description": "In case of `overcommit` being `true`, calculations are done in the following manner:\n1. If a VM has requested 10G but is only consuming 5G, only 5G will be counted\n2. System will consider shrinkable ZFS ARC as free memory ( shrinkable ZFS ARC is current ZFS ARC\n minus ZFS ARC minimum )\nIn case of `overcommit` being `false`, calculations are done in the following manner:\n1. Complete VM requested memory will be taken into account regardless of how much actual physical\n memory the VM is consuming\n2. System will not consider shrinkable ZFS ARC as free memory"
}
|
Return Arguments:
{
"type": "integer",
"_name_": "available_memory",
"title": "available_memory",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Get the current maximum amount of available memory to be allocated for VMs. In case of In case of Memory is of course a very "volatile" resource, values may change abruptly between a second but I deem it good enough to give the user a clue about how much memory is available at the current moment and if a VM should be allowed to be launched. |
vm.get_console |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"_name_": "console_device",
"title": "console_device",
"_required_": false,
"type": "string"
}
|
Get the console device from a given guest. |
vm.get_display_devices |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"_name_": "vmdevice",
"title": "vmdevice",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": false,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
"order": {
"type": "integer",
"_name_": "order",
"title": "order",
"_required_": false
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vmdevice",
"title": "vmdevice",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"dtype",
"attributes",
"order",
"vm"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Get the display devices from a given guest. If a display device has password configured,
|
vm.get_display_web_uri |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"_name_": "host",
"title": "host",
"default": "",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"protocol": {
"_name_": "protocol",
"title": "protocol",
"default": "HTTP",
"_required_": false,
"type": "string",
"enum": [
"HTTP",
"HTTPS"
]
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"protocol"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"error": {
"_name_": "error",
"title": "error",
"_required_": false,
"type": [
"string",
"null"
]
},
"uri": {
"_name_": "uri",
"title": "uri",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "display_devices_uri",
"title": "display_devices_uri",
"default": {},
"_required_": false,
"_attrs_order_": [
"error",
"uri"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve Display URI for a given VM or appropriate error if there is no display device available or if it is not configured to use web interface |
vm.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"status": {
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
},
"display_available": {
"type": "boolean",
"_name_": "display_available",
"title": "display_available",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
},
"additionalProperties": false,
"_name_": "vm_entry",
"title": "vm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"devices",
"status",
"display_available",
"id"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Returns instance matching Please see |
vm.get_memory_usage |
---|
Arguments:
{
"type": "integer",
"_name_": "vm_id",
"title": "vm_id",
"_required_": false
}
|
Return Arguments:
{
"type": "integer",
"_name_": "memory_usage",
"title": "memory_usage",
"description": "Memory usage of a VM in bytes",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
- |
vm.get_vm_memory_info |
---|
Arguments:
{
"type": "integer",
"_name_": "vm_id",
"title": "vm_id",
"_required_": false,
"description": "Returns memory information for `vm_id` VM if it is going to be started."
}
|
Return Arguments:
{
"type": "object",
"properties": {
"minimum_memory_requested": {
"type": "integer",
"_name_": "minimum_memory_requested",
"title": "minimum_memory_requested",
"description": "Minimum memory requested by the VM",
"_required_": false
},
"total_memory_requested": {
"type": "integer",
"_name_": "total_memory_requested",
"title": "total_memory_requested",
"description": "Maximum / total memory requested by the VM",
"_required_": false
},
"overcommit_required": {
"type": "boolean",
"_name_": "overcommit_required",
"title": "overcommit_required",
"description": "Overcommit of memory is required to start VM",
"_required_": false
},
"memory_req_fulfilled_after_overcommit": {
"type": "boolean",
"_name_": "memory_req_fulfilled_after_overcommit",
"title": "memory_req_fulfilled_after_overcommit",
"description": "Memory requirements of VM are fulfilled if over-committing memory is specified",
"_required_": false
},
"arc_to_shrink": {
"type": [
"integer",
"null"
],
"_name_": "arc_to_shrink",
"title": "arc_to_shrink",
"description": "Size of ARC to shrink in bytes",
"_required_": false
},
"current_arc_max": {
"type": "integer",
"_name_": "current_arc_max",
"title": "current_arc_max",
"description": "Current size of max ARC in bytes",
"_required_": false
},
"arc_min": {
"type": "integer",
"_name_": "arc_min",
"title": "arc_min",
"description": "Minimum size of ARC in bytes",
"_required_": false
},
"arc_max_after_shrink": {
"type": "integer",
"_name_": "arc_max_after_shrink",
"title": "arc_max_after_shrink",
"description": "Size of max ARC in bytes after shrinking",
"_required_": false
},
"actual_vm_requested_memory": {
"type": "integer",
"_name_": "actual_vm_requested_memory",
"title": "actual_vm_requested_memory",
"description": "VM memory in bytes to consider when making calculations for available/required memory. If VM ballooning is specified for the VM, the minimum VM memory specified by user will be taken into account otherwise total VM memory requested will be taken into account.",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "get_vm_memory_info",
"title": "get_vm_memory_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"minimum_memory_requested",
"total_memory_requested",
"overcommit_required",
"memory_req_fulfilled_after_overcommit",
"arc_to_shrink",
"current_arc_max",
"arc_min",
"arc_max_after_shrink",
"actual_vm_requested_memory"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Returns memory information for All memory attributes are expressed in bytes. |
vm.get_vmemory_in_use |
---|
Return Arguments:
{
"type": "object",
"properties": {
"RNP": {
"type": "integer",
"_name_": "RNP",
"title": "RNP",
"description": "Running but not provisioned",
"_required_": true
},
"PRD": {
"type": "integer",
"_name_": "PRD",
"title": "PRD",
"description": "Provisioned but not running",
"_required_": true
},
"RPRD": {
"type": "integer",
"_name_": "RPRD",
"title": "RPRD",
"description": "Running and provisioned",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "vmemory_in_use",
"title": "vmemory_in_use",
"default": {},
"_required_": false,
"_attrs_order_": [
"RNP",
"PRD",
"RPRD"
]
}
|
The total amount of virtual memory in MB used by guests
|
vm.guest_architecture_and_machine_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "guest_architecture_and_machine_choices",
"title": "guest_architecture_and_machine_choices",
"description": "\n\nExample(s):\n```\n{\n \"x86_64\": [\n \"pc-i440fx-5.2\",\n \"pc-q35-5.2\",\n \"pc-i440fx-2.7\"\n ],\n \"i686\": [\n \"pc-i440fx-3.0\",\n \"xenfv\"\n ]\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve choices for supported guest architecture types and machine choices. Keys in the response would be supported guest architecture(s) on the host and their respective values would be supported machine type(s) for the specific architecture on the host. |
vm.import_disk_image
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "object",
"properties": {
"diskimg": {
"_name_": "diskimg",
"title": "diskimg",
"_required_": true,
"type": "string",
"description": "`diskimg` is an required parameter for the incoming disk image"
},
"zvol": {
"_name_": "zvol",
"title": "zvol",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "vm_info",
"title": "vm_info",
"default": {},
"_required_": false,
"_attrs_order_": [
"diskimg",
"zvol"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "import_disk_image",
"title": "import_disk_image",
"_required_": false
}
|
Imports a specified disk image. Utilized qemu-img with the auto-detect functionality to auto-convert any supported disk image format to RAW -> ZVOL As of this implementation it supports:
|
vm.log_file_download |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Retrieve log file contents of `id` VM."
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve log file contents of It will download empty file if log file does not exist. |
vm.log_file_path |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Retrieve log file path of `id` VM."
}
|
Return Arguments:
{
"_name_": "log_file_path",
"title": "log_file_path",
"_required_": false,
"type": [
"string",
"null"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve log file path of It will return path of the log file if it exists and |
vm.maximum_supported_vcpus |
---|
Return Arguments:
{
"type": "integer",
"_name_": "maximum_supported_vcpus",
"title": "maximum_supported_vcpus",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Returns maximum supported VCPU's |
vm.port_wizard |
---|
Return Arguments:
{
"type": "object",
"properties": {
"port": {
"type": "integer",
"_name_": "port",
"title": "port",
"description": "Available server port",
"_required_": true
},
"web": {
"type": "integer",
"_name_": "web",
"title": "web",
"description": "Web port to be used based on available `port`",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "available_display_port",
"title": "available_display_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"port",
"web"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
It returns the next available Display Server Port and Web Port. Returns a dict with two keys |
vm.poweroff |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Poweroff a VM. |
vm.profiles |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "profiles",
"title": "profiles",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
Returns a dictionary of defaults for different VM guest types. |
vm.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"status": {
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
},
"display_available": {
"type": "boolean",
"_name_": "display_available",
"title": "display_available",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_entry",
"title": "vm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"devices",
"status",
"display_available",
"id"
]
}
]
},
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"status": {
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
},
"display_available": {
"type": "boolean",
"_name_": "display_available",
"title": "display_available",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_entry",
"title": "vm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"devices",
"status",
"display_available",
"id"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"status": {
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
},
"display_available": {
"type": "boolean",
"_name_": "display_available",
"title": "display_available",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_entry",
"title": "vm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"devices",
"status",
"display_available",
"id"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
- |
vm.random_mac |
---|
Return Arguments:
{
"_name_": "mac",
"title": "mac",
"_required_": false,
"type": "string"
}
|
Create a random mac address. Returns: str: with six groups of two hexadecimal digits |
vm.resolution_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"1920x1200": {
"_name_": "1920x1200",
"title": "1920x1200",
"_required_": false,
"type": "string",
"enum": [
"1920x1200"
]
},
"1920x1080": {
"_name_": "1920x1080",
"title": "1920x1080",
"_required_": false,
"type": "string",
"enum": [
"1920x1080"
]
},
"1600x1200": {
"_name_": "1600x1200",
"title": "1600x1200",
"_required_": false,
"type": "string",
"enum": [
"1600x1200"
]
},
"1600x900": {
"_name_": "1600x900",
"title": "1600x900",
"_required_": false,
"type": "string",
"enum": [
"1600x900"
]
},
"1400x1050": {
"_name_": "1400x1050",
"title": "1400x1050",
"_required_": false,
"type": "string",
"enum": [
"1400x1050"
]
},
"1280x1024": {
"_name_": "1280x1024",
"title": "1280x1024",
"_required_": false,
"type": "string",
"enum": [
"1280x1024"
]
},
"1280x720": {
"_name_": "1280x720",
"title": "1280x720",
"_required_": false,
"type": "string",
"enum": [
"1280x720"
]
},
"1024x768": {
"_name_": "1024x768",
"title": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1024x768"
]
},
"800x600": {
"_name_": "800x600",
"title": "800x600",
"_required_": false,
"type": "string",
"enum": [
"800x600"
]
},
"640x480": {
"_name_": "640x480",
"title": "640x480",
"_required_": false,
"type": "string",
"enum": [
"640x480"
]
}
},
"additionalProperties": false,
"_name_": "resolution_choices",
"title": "resolution_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve supported resolution choices for VM Display devices. |
vm.restart
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Restart a VM. |
vm.resume |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Resume suspended |
vm.start |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"overcommit": {
"type": "boolean",
"_name_": "overcommit",
"title": "overcommit",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"overcommit"
]
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Start a VM. options.overcommit defaults to false, meaning VMs are not allowed to start if there is not enough available memory to hold all configured VMs. If true, VM starts even if there is not enough memory for all configured VMs. Error codes:
|
vm.status |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Get the status of `id` VM."
}
|
Return Arguments:
{
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "vm_status",
"title": "vm_status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Get the status of Returns a dict: - state, RUNNING / STOPPED / SUSPENDED - pid, process id if RUNNING |
vm.stop
Job
This endpoint is a Job. Please refer to the Jobs section for details.
|
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
},
"force_after_timeout": {
"type": "boolean",
"_name_": "force_after_timeout",
"title": "force_after_timeout",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"force",
"force_after_timeout"
]
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Stops a VM. For unresponsive guests who have exceeded the
|
vm.supports_virtualization |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "supports_virtualization",
"title": "supports_virtualization",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Returns "true" if system supports virtualization, "false" otherwise |
vm.suspend |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Suspend |
vm.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "1) If there is no device in the `devices` list which was previously attached to the VM, that device is\n removed from the virtual machine.\n2) Devices are updated in the `devices` list when they contain a valid `id` attribute that corresponds to\n an existing device.\n3) Devices that do not have an `id` attribute are created and attached to `id` VM.\nCreate a Virtual Machine (VM)."
}
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false,
"description": "`hyperv_enlightenments` can be used to enable subset of predefined Hyper-V enlightenments for Windows guests.\nThese enlightenments improve performance and enable otherwise missing features."
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false,
"description": "`hide_from_msr` is a boolean which when set will hide the KVM hypervisor from standard MSR based discovery and\nis useful to enable when doing GPU passthrough."
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false,
"description": "`ensure_display_device` when set ( the default ) will ensure that the guest always has access to a video device.\nFor headless installations like ubuntu server this is required for the guest to operate properly. However\nfor cases where consumer would like to use GPU passthrough and does not want a display device added should set\nthis to `false`."
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false,
"description": "`shutdown_timeout` indicates the time in seconds the system waits for the VM to cleanly shutdown. During system\nshutdown, if the VM hasn't exited after a hardware shutdown signal has been sent by the system within\n`shutdown_timeout` seconds, system initiates poweroff for the VM to stop it."
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`arch_type` refers to architecture type and can be specified for the guest. By default the value is `null` and\nsystem in this case will choose a reasonable default based on host.\n`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "1) If there is no device in the `devices` list which was previously attached to the VM, that device is\n removed from the virtual machine.\n2) Devices are updated in the `devices` list when they contain a valid `id` attribute that corresponds to\n an existing device.\n3) Devices that do not have an `id` attribute are created and attached to `id` VM.\nCreate a Virtual Machine (VM)."
}
},
"additionalProperties": false,
"_name_": "vm_update",
"title": "vm_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"id"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false,
"description": "Maximum of 16 guest virtual CPUs are allowed. By default, every virtual CPU is configured as a\nseparate package. Multiple cores can be configured per CPU by specifying `cores` attributes.\n`vcpus` specifies total number of CPU sockets. `cores` specifies number of cores per socket. `threads`\nspecifies number of threads per core."
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false,
"description": "`hyperv_enlightenments` can be used to enable subset of predefined Hyper-V enlightenments for Windows guests.\nThese enlightenments improve performance and enable otherwise missing features."
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false,
"description": "`hide_from_msr` is a boolean which when set will hide the KVM hypervisor from standard MSR based discovery and\nis useful to enable when doing GPU passthrough."
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false,
"description": "`ensure_display_device` when set ( the default ) will ensure that the guest always has access to a video device.\nFor headless installations like ubuntu server this is required for the guest to operate properly. However\nfor cases where consumer would like to use GPU passthrough and does not want a display device added should set\nthis to `false`."
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false,
"description": "`shutdown_timeout` indicates the time in seconds the system waits for the VM to cleanly shutdown. During system\nshutdown, if the VM hasn't exited after a hardware shutdown signal has been sent by the system within\n`shutdown_timeout` seconds, system initiates poweroff for the VM to stop it."
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`arch_type` refers to architecture type and can be specified for the guest. By default the value is `null` and\nsystem in this case will choose a reasonable default based on host.\n`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
],
"description": "`machine_type` refers to machine type of the guest based on the architecture type selected with `arch_type`.\nBy default the value is `null` and system in this case will choose a reasonable default based on `arch_type`\nconfiguration."
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": [],
"description": "`devices` is a list of virtualized hardware to attach to the virtual machine. If `devices` is not present,\nno change is made to devices. If either the device list order or data stored by the device changes when the\nattribute is passed, these actions are taken:\n1) If there is no device in the `devices` list which was previously attached to the VM, that device is\n removed from the virtual machine.\n2) Devices are updated in the `devices` list when they contain a valid `id` attribute that corresponds to\n an existing device.\n3) Devices that do not have an `id` attribute are created and attached to `id` VM.\nCreate a Virtual Machine (VM)."
},
"status": {
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
},
"display_available": {
"type": "boolean",
"_name_": "display_available",
"title": "display_available",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "1) If there is no device in the `devices` list which was previously attached to the VM, that device is\n removed from the virtual machine.\n2) Devices are updated in the `devices` list when they contain a valid `id` attribute that corresponds to\n an existing device.\n3) Devices that do not have an `id` attribute are created and attached to `id` VM.\nCreate a Virtual Machine (VM)."
}
},
"additionalProperties": false,
"_name_": "vm_update_returns",
"title": "vm_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"devices",
"status",
"display_available",
"id"
]
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE, VM_WRITE |
Update all information of a specific VM.
1) If there is no device in the |
vm.virtualization_details |
---|
Return Arguments:
{
"type": "object",
"properties": {
"supported": {
"type": "boolean",
"_name_": "supported",
"title": "supported",
"_required_": true
},
"error": {
"_name_": "error",
"title": "error",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "virtualization_details",
"title": "virtualization_details",
"default": {},
"_required_": false,
"_attrs_order_": [
"supported",
"error"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE, VM_READ, VM_WRITE |
Retrieve details if virtualization is supported on the system and in case why it's not supported if it isn't. |
vm.device.bind_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "bind_choices",
"title": "bind_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Available choices for Bind attribute. |
vm.device.create |
---|
Arguments:
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
],
"description": "If `dtype` is the `RAW` type and a new raw file is to be created, `attributes.exists` will be passed as false.\nThis means the API handles creating the raw file and raises the appropriate exception if file creation fails."
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true,
"description": "Create a new device for the VM of id `vm`."
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": null,
"_required_": false,
"_attrs_order_": []
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vmdevice_create",
"title": "vmdevice_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"attributes",
"order"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
],
"description": "If `dtype` is the `RAW` type and a new raw file is to be created, `attributes.exists` will be passed as false.\nThis means the API handles creating the raw file and raises the appropriate exception if file creation fails."
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true,
"description": "Create a new device for the VM of id `vm`."
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_create_returns",
"title": "vm_device_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"id",
"attributes"
]
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE |
Create a new device for the VM of id If If |
vm.device.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
{
"type": "object",
"properties": {
"zvol": {
"type": "boolean",
"_name_": "zvol",
"title": "zvol",
"default": false,
"_required_": false
},
"raw_file": {
"type": "boolean",
"_name_": "raw_file",
"title": "raw_file",
"default": false,
"_required_": false
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_delete",
"title": "vm_device_delete",
"default": {},
"_required_": false,
"_attrs_order_": [
"zvol",
"raw_file",
"force"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE |
Delete a VM device of |
vm.device.disk_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "disk_choices",
"title": "disk_choices",
"description": "\n\nExample(s):\n```\n{\n \"vms/test 1\": \"/dev/zvol/vms/test+1\"\n}\n```\n",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Returns disk choices for device type "DISK". |
vm.device.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
]
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_entry",
"title": "vm_device_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"id",
"attributes"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Returns instance matching Please see |
vm.device.get_pci_ids_for_gpu_isolation |
---|
Arguments:
{
"_name_": "gpu_pci_id",
"title": "gpu_pci_id",
"_required_": false,
"type": "string",
"description": "Get PCI IDs of devices which are required to be isolated for `gpu_pci_id` GPU isolation."
}
|
Return Arguments:
{
"_name_": "get_pci_ids_for_gpu_isolation",
"title": "get_pci_ids_for_gpu_isolation",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "pci_ids",
"title": "pci_ids",
"_required_": false,
"type": "string"
}
]
}
|
Get PCI IDs of devices which are required to be isolated for Basically when a GPU passthrough is desired for a VM, we need to isolate all the devices which are in the same IOMMU group as the GPU. This is required because if we don't do this, the VM will not be able to start because the devices in the same IOMMU group as the GPU will be in use by the host and will not be available for the VM to use. This endpoints retrieves all the PCI devices which are in the same IOMMU group as the GPU and returns their PCI IDs so UI can use those and create PCI devices for them and isolate them. |
vm.device.iommu_enabled |
---|
Return Arguments:
{
"type": "boolean",
"_name_": "iommu_enabled",
"title": "iommu_enabled",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Returns "true" if iommu is enabled, "false" otherwise |
vm.device.iotype_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"NATIVE": {
"_name_": "NATIVE",
"title": "NATIVE",
"_required_": false,
"type": "string",
"enum": [
"NATIVE"
]
},
"THREADS": {
"_name_": "THREADS",
"title": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"THREADS"
]
},
"IO_URING": {
"_name_": "IO_URING",
"title": "IO_URING",
"_required_": false,
"type": "string",
"enum": [
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "iotype_choices",
"title": "iotype_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
IO-type choices for storage devices. |
vm.device.nic_attach_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "nic_attach_choices",
"title": "nic_attach_choices",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Available choices for NIC Attach attribute. |
vm.device.passthrough_device |
---|
Arguments:
{
"_name_": "device",
"title": "device",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"class": {
"_name_": "class",
"title": "class",
"_required_": true,
"type": [
"string",
"null"
]
},
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": [
"string",
"null"
]
},
"slot": {
"_name_": "slot",
"title": "slot",
"_required_": true,
"type": [
"string",
"null"
]
},
"function": {
"_name_": "function",
"title": "function",
"_required_": true,
"type": [
"string",
"null"
]
},
"product": {
"_name_": "product",
"title": "product",
"_required_": true,
"type": [
"string",
"null"
]
},
"vendor": {
"_name_": "vendor",
"title": "vendor",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "capability",
"title": "capability",
"default": {},
"_required_": true,
"_attrs_order_": [
"class",
"domain",
"bus",
"slot",
"function",
"product",
"vendor"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"_required_": true,
"type": [
"string",
"null"
]
},
"iommu_group": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"addresses": {
"_name_": "addresses",
"title": "addresses",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": true,
"type": "string"
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"slot": {
"_name_": "slot",
"title": "slot",
"_required_": true,
"type": "string"
},
"function": {
"_name_": "function",
"title": "function",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "address",
"title": "address",
"default": {},
"_required_": false,
"_attrs_order_": [
"domain",
"bus",
"slot",
"function"
]
}
]
}
},
"additionalProperties": false,
"_name_": "iommu_group",
"title": "iommu_group",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"addresses"
]
},
"available": {
"type": "boolean",
"_name_": "available",
"title": "available",
"_required_": true
},
"drivers": {
"_name_": "drivers",
"title": "drivers",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "driver",
"title": "driver",
"_required_": false,
"type": "string"
}
]
},
"error": {
"_name_": "error",
"title": "error",
"_required_": true,
"type": [
"string",
"null"
]
},
"device_path": {
"_name_": "device_path",
"title": "device_path",
"_required_": true,
"type": [
"string",
"null"
]
},
"reset_mechanism_defined": {
"type": "boolean",
"_name_": "reset_mechanism_defined",
"title": "reset_mechanism_defined",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "passthrough_device",
"title": "passthrough_device",
"default": {},
"_required_": false,
"_attrs_order_": [
"capability",
"controller_type",
"iommu_group",
"available",
"drivers",
"error",
"device_path",
"reset_mechanism_defined",
"description"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Retrieve details about |
vm.device.passthrough_device_choices |
---|
Return Arguments:
{
"_name_": "passthrough_device_choices",
"title": "passthrough_device_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"class": {
"_name_": "class",
"title": "class",
"_required_": true,
"type": [
"string",
"null"
]
},
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": [
"string",
"null"
]
},
"slot": {
"_name_": "slot",
"title": "slot",
"_required_": true,
"type": [
"string",
"null"
]
},
"function": {
"_name_": "function",
"title": "function",
"_required_": true,
"type": [
"string",
"null"
]
},
"product": {
"_name_": "product",
"title": "product",
"_required_": true,
"type": [
"string",
"null"
]
},
"vendor": {
"_name_": "vendor",
"title": "vendor",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "capability",
"title": "capability",
"default": {},
"_required_": true,
"_attrs_order_": [
"class",
"domain",
"bus",
"slot",
"function",
"product",
"vendor"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"_required_": true,
"type": [
"string",
"null"
]
},
"iommu_group": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"addresses": {
"_name_": "addresses",
"title": "addresses",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": true,
"type": "string"
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"slot": {
"_name_": "slot",
"title": "slot",
"_required_": true,
"type": "string"
},
"function": {
"_name_": "function",
"title": "function",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "address",
"title": "address",
"default": {},
"_required_": false,
"_attrs_order_": [
"domain",
"bus",
"slot",
"function"
]
}
]
}
},
"additionalProperties": false,
"_name_": "iommu_group",
"title": "iommu_group",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"addresses"
]
},
"available": {
"type": "boolean",
"_name_": "available",
"title": "available",
"_required_": true
},
"drivers": {
"_name_": "drivers",
"title": "drivers",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "driver",
"title": "driver",
"_required_": false,
"type": "string"
}
]
},
"error": {
"_name_": "error",
"title": "error",
"_required_": true,
"type": [
"string",
"null"
]
},
"device_path": {
"_name_": "device_path",
"title": "device_path",
"_required_": true,
"type": [
"string",
"null"
]
},
"reset_mechanism_defined": {
"type": "boolean",
"_name_": "reset_mechanism_defined",
"title": "reset_mechanism_defined",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "passthrough_device",
"title": "passthrough_device",
"default": {},
"_required_": false,
"_attrs_order_": [
"capability",
"controller_type",
"iommu_group",
"available",
"drivers",
"error",
"device_path",
"reset_mechanism_defined",
"description"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Available choices for PCI passthru devices |
vm.device.pptdev_choices |
---|
Return Arguments:
{
"_name_": "passthrough_device_choices",
"title": "passthrough_device_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"class": {
"_name_": "class",
"title": "class",
"_required_": true,
"type": [
"string",
"null"
]
},
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": [
"string",
"null"
]
},
"slot": {
"_name_": "slot",
"title": "slot",
"_required_": true,
"type": [
"string",
"null"
]
},
"function": {
"_name_": "function",
"title": "function",
"_required_": true,
"type": [
"string",
"null"
]
},
"product": {
"_name_": "product",
"title": "product",
"_required_": true,
"type": [
"string",
"null"
]
},
"vendor": {
"_name_": "vendor",
"title": "vendor",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "capability",
"title": "capability",
"default": {},
"_required_": true,
"_attrs_order_": [
"class",
"domain",
"bus",
"slot",
"function",
"product",
"vendor"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"_required_": true,
"type": [
"string",
"null"
]
},
"iommu_group": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"_name_": "number",
"title": "number",
"_required_": true
},
"addresses": {
"_name_": "addresses",
"title": "addresses",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"domain": {
"_name_": "domain",
"title": "domain",
"_required_": true,
"type": "string"
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": "string"
},
"slot": {
"_name_": "slot",
"title": "slot",
"_required_": true,
"type": "string"
},
"function": {
"_name_": "function",
"title": "function",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "address",
"title": "address",
"default": {},
"_required_": false,
"_attrs_order_": [
"domain",
"bus",
"slot",
"function"
]
}
]
}
},
"additionalProperties": false,
"_name_": "iommu_group",
"title": "iommu_group",
"default": {},
"_required_": true,
"_attrs_order_": [
"number",
"addresses"
]
},
"available": {
"type": "boolean",
"_name_": "available",
"title": "available",
"_required_": true
},
"drivers": {
"_name_": "drivers",
"title": "drivers",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "driver",
"title": "driver",
"_required_": false,
"type": "string"
}
]
},
"error": {
"_name_": "error",
"title": "error",
"_required_": true,
"type": [
"string",
"null"
]
},
"device_path": {
"_name_": "device_path",
"title": "device_path",
"_required_": true,
"type": [
"string",
"null"
]
},
"reset_mechanism_defined": {
"type": "boolean",
"_name_": "reset_mechanism_defined",
"title": "reset_mechanism_defined",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "passthrough_device",
"title": "passthrough_device",
"default": {},
"_required_": false,
"_attrs_order_": [
"capability",
"controller_type",
"iommu_group",
"available",
"drivers",
"error",
"device_path",
"reset_mechanism_defined",
"description"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Available choices for PCI passthru device |
vm.device.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
]
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_entry",
"title": "vm_device_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"id",
"attributes"
]
}
]
},
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
]
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_entry",
"title": "vm_device_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"id",
"attributes"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
]
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_entry",
"title": "vm_device_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"id",
"attributes"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
- |
vm.device.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update a VM device of `id`."
}
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
],
"description": "Pass `attributes.size` to resize a `dtype` `RAW` device. The raw file will be resized.\nIf `dtype` is the `RAW` type and a new raw file is to be created, `attributes.exists` will be passed as false.\nThis means the API handles creating the raw file and raises the appropriate exception if file creation fails."
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true,
"description": "Create a new device for the VM of id `vm`."
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_update",
"title": "vm_device_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"attributes"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
],
"description": "Pass `attributes.size` to resize a `dtype` `RAW` device. The raw file will be resized.\nIf `dtype` is the `RAW` type and a new raw file is to be created, `attributes.exists` will be passed as false.\nThis means the API handles creating the raw file and raises the appropriate exception if file creation fails."
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true,
"description": "Create a new device for the VM of id `vm`."
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update a VM device of `id`."
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_update_returns",
"title": "vm_device_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"id",
"attributes"
]
}
|
This method is accessible to the users granted with the following roles: VM_DEVICE_WRITE |
Update a VM device of Pass |
vm.device.usb_controller_choices |
---|
Return Arguments:
{
"type": "object",
"properties": {
"piix3-uhci": {
"_name_": "piix3-uhci",
"title": "piix3-uhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci"
]
},
"piix4-uhci": {
"_name_": "piix4-uhci",
"title": "piix4-uhci",
"_required_": false,
"type": "string",
"enum": [
"piix4-uhci"
]
},
"ehci": {
"_name_": "ehci",
"title": "ehci",
"_required_": false,
"type": "string",
"enum": [
"ehci"
]
},
"ich9-ehci1": {
"_name_": "ich9-ehci1",
"title": "ich9-ehci1",
"_required_": false,
"type": "string",
"enum": [
"ich9-ehci1"
]
},
"vt82c686b-uhci": {
"_name_": "vt82c686b-uhci",
"title": "vt82c686b-uhci",
"_required_": false,
"type": "string",
"enum": [
"vt82c686b-uhci"
]
},
"pci-ohci": {
"_name_": "pci-ohci",
"title": "pci-ohci",
"_required_": false,
"type": "string",
"enum": [
"pci-ohci"
]
},
"nec-xhci": {
"_name_": "nec-xhci",
"title": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"nec-xhci"
]
},
"qemu-xhci": {
"_name_": "qemu-xhci",
"title": "qemu-xhci",
"_required_": false,
"type": "string",
"enum": [
"qemu-xhci"
]
}
},
"additionalProperties": false,
"_name_": "usb_controller_choices",
"title": "usb_controller_choices",
"default": {},
"_required_": false,
"_attrs_order_": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Retrieve USB controller type choices |
vm.device.usb_passthrough_choices |
---|
Return Arguments:
{
"_name_": "usb_passthrough_choices",
"title": "usb_passthrough_choices",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"product": {
"_name_": "product",
"title": "product",
"_required_": true,
"type": [
"string",
"null"
]
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"_required_": true,
"type": [
"string",
"null"
]
},
"vendor": {
"_name_": "vendor",
"title": "vendor",
"_required_": true,
"type": [
"string",
"null"
]
},
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": [
"string",
"null"
]
},
"device": {
"_name_": "device",
"title": "device",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "capability",
"title": "capability",
"default": {},
"_required_": false,
"_attrs_order_": [
"product",
"product_id",
"vendor",
"vendor_id",
"bus",
"device"
]
},
"available": {
"type": "boolean",
"_name_": "available",
"title": "available",
"_required_": true
},
"error": {
"_name_": "error",
"title": "error",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "usb_passthrough_device",
"title": "usb_passthrough_device",
"default": {},
"_required_": false,
"_attrs_order_": [
"capability",
"available",
"error"
]
}
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Available choices for USB passthrough devices. |
vm.device.usb_passthrough_device |
---|
Arguments:
{
"_name_": "device",
"title": "device",
"_required_": false,
"type": "string"
}
|
Return Arguments:
{
"type": "object",
"properties": {
"capability": {
"type": "object",
"properties": {
"product": {
"_name_": "product",
"title": "product",
"_required_": true,
"type": [
"string",
"null"
]
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"_required_": true,
"type": [
"string",
"null"
]
},
"vendor": {
"_name_": "vendor",
"title": "vendor",
"_required_": true,
"type": [
"string",
"null"
]
},
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"_required_": true,
"type": [
"string",
"null"
]
},
"bus": {
"_name_": "bus",
"title": "bus",
"_required_": true,
"type": [
"string",
"null"
]
},
"device": {
"_name_": "device",
"title": "device",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "capability",
"title": "capability",
"default": {},
"_required_": false,
"_attrs_order_": [
"product",
"product_id",
"vendor",
"vendor_id",
"bus",
"device"
]
},
"available": {
"type": "boolean",
"_name_": "available",
"title": "available",
"_required_": true
},
"error": {
"_name_": "error",
"title": "error",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "usb_passthrough_device",
"title": "usb_passthrough_device",
"default": {},
"_required_": false,
"_attrs_order_": [
"capability",
"available",
"error"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN, VM_DEVICE_READ, VM_DEVICE_WRITE |
Retrieve details about |
vmware.create |
---|
Arguments:
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string",
"description": "`hostname` is a valid IP address / hostname of a VMWare host. When clustering, this is the vCenter server for\nthe cluster."
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
}
},
"additionalProperties": false,
"_name_": "vmware_create",
"title": "vmware_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string",
"description": "`hostname` is a valid IP address / hostname of a VMWare host. When clustering, this is the vCenter server for\nthe cluster."
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "vmware_create_returns",
"title": "vmware_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username",
"id",
"state"
]
}
|
Create VMWare snapshot.
|
vmware.dataset_has_vms |
---|
Arguments:
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
{
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns "true" if |
vmware.delete |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
Delete VMWare snapshot of |
vmware.get_datastores |
---|
Arguments:
{
"type": "object",
"properties": {
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "vmware-creds",
"title": "vmware-creds",
"default": {},
"_required_": false,
"_attrs_order_": [
"hostname",
"username",
"password"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Get datastores from VMWare. |
vmware.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "vmware_entry",
"title": "vmware_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username",
"id",
"state"
]
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns instance matching Please see |
vmware.get_virtual_machines |
---|
Arguments:
{
"type": "integer",
"_name_": "pk",
"title": "pk",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
Returns Virtual Machines on the VMWare host identified by |
vmware.match_datastores_with_datasets |
---|
Arguments:
{
"type": "object",
"properties": {
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "vmware-creds",
"title": "vmware-creds",
"default": {},
"_required_": false,
"_attrs_order_": [
"hostname",
"username",
"password"
]
}
|
Requests datastores from vCenter server and tries to match them with local filesystems. Returns a list of datastores, a list of local filesystems and guessed relationship between them. |
|
vmware.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "vmware_entry",
"title": "vmware_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username",
"id",
"state"
]
}
]
},
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "vmware_entry",
"title": "vmware_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username",
"id",
"state"
]
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "vmware_entry",
"title": "vmware_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username",
"id",
"state"
]
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, SHARING_ADMIN |
- |
vmware.update |
---|
Arguments:
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true,
"description": "Update VMWare snapshot of `id`.\nCreate VMWare snapshot."
}
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string",
"description": "`hostname` is a valid IP address / hostname of a VMWare host. When clustering, this is the vCenter server for\nthe cluster."
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
}
},
"additionalProperties": false,
"_name_": "vmware_update",
"title": "vmware_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string",
"description": "`hostname` is a valid IP address / hostname of a VMWare host. When clustering, this is the vCenter server for\nthe cluster."
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string",
"description": "`username` and `password` are the credentials used to authorize access to the VMWare host."
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Update VMWare snapshot of `id`.\nCreate VMWare snapshot."
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "vmware_update_returns",
"title": "vmware_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username",
"id",
"state"
]
}
|
Update VMWare snapshot of |
zfs.snapshot.clone |
---|
Arguments:
{
"type": "object",
"properties": {
"snapshot": {
"_name_": "snapshot",
"title": "snapshot",
"_required_": true,
"type": "string"
},
"dataset_dst": {
"_name_": "dataset_dst",
"title": "dataset_dst",
"_required_": true,
"type": "string"
},
"dataset_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "dataset_properties",
"title": "dataset_properties",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "snapshot_clone",
"title": "snapshot_clone",
"default": {},
"_required_": false,
"_attrs_order_": [
"snapshot",
"dataset_dst",
"dataset_properties"
]
}
|
Clone a given snapshot to a new dataset. Returns: bool: True if succeed otherwise False. |
zfs.snapshot.create |
---|
Arguments:
{
"type": "object",
"properties": {
"dataset": {
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"naming_schema": {
"_name_": "naming_schema",
"title": "naming_schema",
"_required_": false,
"type": "string"
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "dataset",
"title": "dataset",
"_required_": false,
"type": "string"
}
]
},
"suspend_vms": {
"type": "boolean",
"_name_": "suspend_vms",
"title": "suspend_vms",
"default": false,
"_required_": false
},
"vmware_sync": {
"type": "boolean",
"_name_": "vmware_sync",
"title": "vmware_sync",
"default": false,
"_required_": false
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "snapshot_create",
"title": "snapshot_create",
"default": {},
"_required_": false,
"_attrs_order_": [
"dataset",
"name",
"naming_schema",
"recursive",
"exclude",
"suspend_vms",
"vmware_sync",
"properties"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "zfs_snapshot_create_returns",
"title": "zfs_snapshot_create_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, SNAPSHOT_WRITE |
Take a snapshot from a given dataset. |
zfs.snapshot.delete |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Delete snapshot of name `id`."
}
{
"type": "object",
"properties": {
"defer": {
"type": "boolean",
"_name_": "defer",
"title": "defer",
"default": false,
"_required_": false
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"defer",
"recursive"
]
}
|
Return Arguments:
{
"type": "boolean",
"_name_": "deleted",
"title": "deleted",
"description": "Will return `true` if `id` is deleted successfully",
"_required_": false
}
|
This method is accessible to the users granted with the following roles: SNAPSHOT_DELETE |
Delete snapshot of name
|
zfs.snapshot.get_instance |
---|
Arguments:
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": false,
"_name_": "id",
"title": "id",
"_required_": false,
"description": "Returns instance matching `id`. If `id` is not found, Validation error is raised."
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options-get_instance",
"title": "query-options-get_instance",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "zfs_snapshot_entry",
"title": "zfs_snapshot_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPLICATION_ADMIN, SHARING_ADMIN, SNAPSHOT_READ, SNAPSHOT_WRITE |
Returns instance matching Please see |
zfs.snapshot.hold |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Holds snapshot `id`."
}
{
"type": "object",
"properties": {
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"recursive"
]
}
|
Holds snapshot
|
zfs.snapshot.query |
---|
Arguments:
{
"_name_": "query-filters",
"title": "query-filters",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "query-filter",
"title": "query-filter",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
]
}
{
"type": "object",
"properties": {
"relationships": {
"type": "boolean",
"_name_": "relationships",
"title": "relationships",
"default": true,
"_required_": false
},
"extend": {
"_name_": "extend",
"title": "extend",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extend_context": {
"_name_": "extend_context",
"title": "extend_context",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"prefix": {
"_name_": "prefix",
"title": "prefix",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"order_by": {
"_name_": "order_by",
"title": "order_by",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"select": {
"_name_": "select",
"title": "select",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"count": {
"type": "boolean",
"_name_": "count",
"title": "count",
"default": false,
"_required_": false
},
"get": {
"type": "boolean",
"_name_": "get",
"title": "get",
"default": false,
"_required_": false
},
"offset": {
"type": "integer",
"_name_": "offset",
"title": "offset",
"default": 0,
"_required_": false
},
"limit": {
"type": "integer",
"_name_": "limit",
"title": "limit",
"default": 0,
"_required_": false
},
"force_sql_filters": {
"type": "boolean",
"_name_": "force_sql_filters",
"title": "force_sql_filters",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "query-options",
"title": "query-options",
"default": {},
"_required_": false,
"_attrs_order_": [
"relationships",
"extend",
"extend_context",
"prefix",
"extra",
"order_by",
"select",
"count",
"get",
"offset",
"limit",
"force_sql_filters"
]
}
|
Return Arguments:
{
"anyOf": [
{
"_name_": "query_result",
"title": "query_result",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "zfs_snapshot_entry",
"title": "zfs_snapshot_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "zfs_snapshot_entry",
"title": "zfs_snapshot_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
},
{
"type": "integer",
"_name_": "count",
"title": "count",
"_required_": false
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "zfs_snapshot_entry",
"title": "zfs_snapshot_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "query_result",
"description": null,
"_required_": false
}
|
This method is accessible to the users granted with the following roles: READONLY_ADMIN, REPLICATION_ADMIN, SHARING_ADMIN, SNAPSHOT_READ, SNAPSHOT_WRITE |
Query all ZFS Snapshots with
|
zfs.snapshot.release |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Release held snapshot `id`."
}
{
"type": "object",
"properties": {
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"recursive"
]
}
|
Release held snapshot Will remove all hold tags from the specified snapshot.
|
zfs.snapshot.remove |
---|
Arguments:
{
"type": "object",
"properties": {
"dataset": {
"_name_": "dataset",
"title": "dataset",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"defer_delete": {
"type": "boolean",
"_name_": "defer_delete",
"title": "defer_delete",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapshot_remove",
"title": "snapshot_remove",
"default": {},
"_required_": false,
"_attrs_order_": [
"dataset",
"name",
"defer_delete"
]
}
|
This method is accessible to the users granted with the following roles: SNAPSHOT_DELETE |
Remove a snapshot from a given dataset. Returns: bool: True if succeed otherwise False. |
zfs.snapshot.rollback |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string",
"description": "Rollback to a given snapshot `id`."
}
{
"type": "object",
"properties": {
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"default": false,
"_required_": false,
"description": "`options.recursive_clones` is just like `recursive` but will also destroy any clones."
},
"recursive_clones": {
"type": "boolean",
"_name_": "recursive_clones",
"title": "recursive_clones",
"default": false,
"_required_": false
},
"force": {
"type": "boolean",
"_name_": "force",
"title": "force",
"default": false,
"_required_": false
},
"recursive_rollback": {
"type": "boolean",
"_name_": "recursive_rollback",
"title": "recursive_rollback",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "options",
"title": "options",
"default": {},
"_required_": false,
"_attrs_order_": [
"recursive",
"recursive_clones",
"force",
"recursive_rollback"
]
}
|
Rollback to a given snapshot
|
zfs.snapshot.update |
---|
Arguments:
{
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
}
{
"type": "object",
"properties": {
"user_properties_update": {
"_name_": "user_properties_update",
"title": "user_properties_update",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"key": {
"_name_": "key",
"title": "key",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": "string"
},
"remove": {
"type": "boolean",
"_name_": "remove",
"title": "remove",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "user_property",
"title": "user_property",
"default": {},
"_required_": false,
"_attrs_order_": [
"key",
"value",
"remove"
]
}
]
}
},
"additionalProperties": false,
"_name_": "snapshot_update",
"title": "snapshot_update",
"default": {},
"_required_": false,
"_attrs_order_": [
"user_properties_update"
]
}
|
Return Arguments:
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "zfs_snapshot_update_returns",
"title": "zfs_snapshot_update_returns",
"default": {},
"_required_": false,
"_attrs_order_": []
}
|
This method is accessible to the users granted with the following roles: REPLICATION_ADMIN, SNAPSHOT_WRITE |
- |
Events are triggers that are generated under certain scenarios or at a certain period of time.
Some events can accept arguments and return results that are influenced by those arguments. Follow this format to pass arguments to events:
event_name:arg
If arg
is accepted by the event, it is parsed automatically. Events that do not accept
arguments only use the event name when subscribing to the event.
Updates on job changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "core.get_jobs",
"title": "core.get_jobs",
"_required_": false
}
]
Sent on acme.dns.authenticator changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"authenticator": {
"_name_": "authenticator",
"title": "authenticator",
"_required_": true,
"type": "string",
"enum": [
"cloudflare",
"route53",
"OVH",
"shell"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `authenticator`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of authenticator",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "acme_dns_authenticator_entry",
"title": "acme_dns_authenticator_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"authenticator",
"attributes",
"name"
]
}
]
Sent on alertservice changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"level": {
"_name_": "level",
"title": "level",
"_required_": true,
"type": "string",
"enum": [
"INFO",
"NOTICE",
"WARNING",
"ERROR",
"CRITICAL",
"ALERT",
"EMERGENCY"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type__title": {
"_name_": "type__title",
"title": "type__title",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alertservice_entry",
"title": "alertservice_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"level",
"enabled",
"id",
"type__title"
]
}
]
Sent on api_key changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "api_key_entry",
"title": "api_key_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on app changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"CRASHED",
"DEPLOYING",
"RUNNING",
"STOPPED"
]
},
"upgrade_available": {
"type": "boolean",
"_name_": "upgrade_available",
"title": "upgrade_available",
"_required_": false
},
"human_version": {
"_name_": "human_version",
"title": "human_version",
"_required_": false,
"type": "string"
},
"version": {
"_name_": "version",
"title": "version",
"_required_": false,
"type": "string"
},
"metadata": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "metadata",
"title": "metadata",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"active_workloads": {
"type": "object",
"properties": {
"containers": {
"type": "integer",
"_name_": "containers",
"title": "containers",
"_required_": false
},
"used_ports": {
"_name_": "used_ports",
"title": "used_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"container_port": {
"_name_": "container_port",
"title": "container_port",
"_required_": false,
"type": "string"
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": "string"
},
"host_ports": {
"_name_": "host_ports",
"title": "host_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"host_port": {
"_name_": "host_port",
"title": "host_port",
"_required_": false,
"type": "string"
},
"host_ip": {
"_name_": "host_ip",
"title": "host_ip",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "host_port",
"title": "host_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"host_port",
"host_ip"
]
}
]
}
},
"additionalProperties": true,
"_name_": "used_port",
"title": "used_port",
"default": {},
"_required_": false,
"_attrs_order_": [
"container_port",
"protocol",
"host_ports"
]
}
]
},
"container_details": {
"_name_": "container_details",
"title": "container_details",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"service_name": {
"_name_": "service_name",
"title": "service_name",
"_required_": false,
"type": "string"
},
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"port_config": {
"_name_": "port_config",
"title": "port_config",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string",
"enum": [
"running",
"starting",
"exited"
]
},
"volume_mounts": {
"_name_": "volume_mounts",
"title": "volume_mounts",
"default": [],
"_required_": false,
"type": "array",
"items": []
}
},
"additionalProperties": true,
"_name_": "container_detail",
"title": "container_detail",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service_name",
"image",
"port_config",
"state",
"volume_mounts"
]
}
]
},
"volumes": {
"_name_": "volumes",
"title": "volumes",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": "string"
},
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": false,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "volume",
"title": "volume",
"default": {},
"_required_": false,
"_attrs_order_": [
"source",
"destination",
"mode",
"type"
]
}
]
}
},
"additionalProperties": true,
"_name_": "active_workloads",
"title": "active_workloads",
"default": {},
"_required_": false,
"_attrs_order_": [
"containers",
"used_ports",
"container_details",
"volumes"
]
}
},
"additionalProperties": true,
"_name_": "app_entry",
"title": "app_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"id",
"state",
"upgrade_available",
"human_version",
"version",
"metadata",
"active_workloads"
]
}
]
Sent on app.image changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"repo_tags": {
"_name_": "repo_tags",
"title": "repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_tag",
"title": "repo_tag",
"_required_": false,
"type": "string"
}
]
},
"repo_digests": {
"_name_": "repo_digests",
"title": "repo_digests",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "repo_digest",
"title": "repo_digest",
"_required_": false,
"type": "string"
}
]
},
"size": {
"type": "integer",
"_name_": "size",
"title": "size",
"_required_": false
},
"dangling": {
"type": "boolean",
"_name_": "dangling",
"title": "dangling",
"_required_": false
},
"update_available": {
"type": "boolean",
"_name_": "update_available",
"title": "update_available",
"_required_": false
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"author": {
"_name_": "author",
"title": "author",
"_required_": false,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"parsed_repo_tags": {
"_name_": "parsed_repo_tags",
"title": "parsed_repo_tags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"image": {
"_name_": "image",
"title": "image",
"_required_": false,
"type": "string"
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string"
},
"registry": {
"_name_": "registry",
"title": "registry",
"_required_": false,
"type": "string"
},
"complete_tag": {
"_name_": "complete_tag",
"title": "complete_tag",
"_required_": false,
"type": "string"
}
},
"additionalProperties": true,
"_name_": "parsed_repo_tag",
"title": "parsed_repo_tag",
"default": {},
"_required_": false,
"_attrs_order_": [
"image",
"tag",
"registry",
"complete_tag"
]
}
]
}
},
"additionalProperties": true,
"_name_": "app_image_entry",
"title": "app_image_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"repo_tags",
"repo_digests",
"size",
"dangling",
"update_available",
"created",
"author",
"comment",
"parsed_repo_tags"
]
}
]
Sent on bootenv changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": false,
"type": "string"
},
"realname": {
"_name_": "realname",
"title": "realname",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"active": {
"_name_": "active",
"title": "active",
"_required_": false,
"type": "string"
},
"activated": {
"type": "boolean",
"_name_": "activated",
"title": "activated",
"_required_": false
},
"can_activate": {
"type": "boolean",
"_name_": "can_activate",
"title": "can_activate",
"_required_": false
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": "string"
},
"space": {
"_name_": "space",
"title": "space",
"_required_": false,
"type": "string"
},
"created": {
"_name_": "created",
"title": "created",
"_required_": false,
"type": "string"
},
"keep": {
"type": "boolean",
"_name_": "keep",
"title": "keep",
"_required_": false
},
"rawspace": {
"type": "integer",
"_name_": "rawspace",
"title": "rawspace",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "bootenv_entry",
"title": "bootenv_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"realname",
"name",
"active",
"activated",
"can_activate",
"mountpoint",
"space",
"created",
"keep",
"rawspace"
]
}
]
Sent on certificate changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificate_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
]
Sent on certificateauthority changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"type": "integer",
"_name_": "type",
"title": "type",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"certificate": {
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey": {
"_name_": "privatekey",
"title": "privatekey",
"_required_": false,
"type": [
"string",
"null"
]
},
"CSR": {
"_name_": "CSR",
"title": "CSR",
"_required_": false,
"type": [
"string",
"null"
]
},
"acme_uri": {
"_name_": "acme_uri",
"title": "acme_uri",
"_required_": false,
"type": [
"string",
"null"
]
},
"domains_authenticators": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "domains_authenticators",
"title": "domains_authenticators",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"renew_days": {
"type": "integer",
"_name_": "renew_days",
"title": "renew_days",
"_required_": false
},
"revoked_date": {
"_name_": "revoked_date",
"title": "revoked_date",
"_required_": false,
"type": [
"string",
"null"
]
},
"signedby": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "signedby",
"title": "signedby",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"root_path": {
"_name_": "root_path",
"title": "root_path",
"_required_": false,
"type": "string"
},
"acme": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "acme",
"title": "acme",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"certificate_path": {
"_name_": "certificate_path",
"title": "certificate_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"privatekey_path": {
"_name_": "privatekey_path",
"title": "privatekey_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"csr_path": {
"_name_": "csr_path",
"title": "csr_path",
"_required_": false,
"type": [
"string",
"null"
]
},
"cert_type": {
"_name_": "cert_type",
"title": "cert_type",
"_required_": false,
"type": "string"
},
"revoked": {
"type": "boolean",
"_name_": "revoked",
"title": "revoked",
"_required_": false
},
"expired": {
"type": [
"boolean",
"null"
],
"_name_": "expired",
"title": "expired",
"_required_": false
},
"issuer": {
"anyOf": [
{
"_name_": "issuer",
"title": "issuer",
"_required_": false,
"type": [
"string",
"null"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "issuer",
"title": "issuer",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "issuer",
"description": null,
"_required_": false
},
"chain_list": {
"_name_": "chain_list",
"title": "chain_list",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "certificate",
"title": "certificate",
"_required_": false,
"type": "string"
}
]
},
"country": {
"_name_": "country",
"title": "country",
"_required_": false,
"type": [
"string",
"null"
]
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": [
"string",
"null"
]
},
"city": {
"_name_": "city",
"title": "city",
"_required_": false,
"type": [
"string",
"null"
]
},
"organization": {
"_name_": "organization",
"title": "organization",
"_required_": false,
"type": [
"string",
"null"
]
},
"organizational_unit": {
"_name_": "organizational_unit",
"title": "organizational_unit",
"_required_": false,
"type": [
"string",
"null"
]
},
"san": {
"_name_": "san",
"title": "san",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": [
{
"_name_": "san_entry",
"title": "san_entry",
"_required_": false,
"type": "string"
}
]
},
"email": {
"_name_": "email",
"title": "email",
"_required_": false,
"type": [
"string",
"null"
]
},
"DN": {
"_name_": "DN",
"title": "DN",
"_required_": false,
"type": [
"string",
"null"
]
},
"subject_name_hash": {
"_name_": "subject_name_hash",
"title": "subject_name_hash",
"_required_": false,
"type": [
"string",
"null"
]
},
"digest_algorithm": {
"_name_": "digest_algorithm",
"title": "digest_algorithm",
"_required_": false,
"type": [
"string",
"null"
]
},
"from": {
"_name_": "from",
"title": "from",
"_required_": false,
"type": [
"string",
"null"
]
},
"common": {
"_name_": "common",
"title": "common",
"_required_": false,
"type": [
"string",
"null"
]
},
"until": {
"_name_": "until",
"title": "until",
"_required_": false,
"type": [
"string",
"null"
]
},
"fingerprint": {
"_name_": "fingerprint",
"title": "fingerprint",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_type": {
"_name_": "key_type",
"title": "key_type",
"_required_": false,
"type": [
"string",
"null"
]
},
"internal": {
"_name_": "internal",
"title": "internal",
"_required_": false,
"type": [
"string",
"null"
]
},
"lifetime": {
"type": [
"integer",
"null"
],
"_name_": "lifetime",
"title": "lifetime",
"_required_": false
},
"serial": {
"type": [
"integer",
"null"
],
"_name_": "serial",
"title": "serial",
"_required_": false
},
"key_length": {
"type": [
"integer",
"null"
],
"_name_": "key_length",
"title": "key_length",
"_required_": false
},
"add_to_trusted_store": {
"type": "boolean",
"_name_": "add_to_trusted_store",
"title": "add_to_trusted_store",
"default": false,
"_required_": false
},
"chain": {
"type": [
"boolean",
"null"
],
"_name_": "chain",
"title": "chain",
"_required_": false
},
"CA_type_existing": {
"type": "boolean",
"_name_": "CA_type_existing",
"title": "CA_type_existing",
"_required_": false
},
"CA_type_internal": {
"type": "boolean",
"_name_": "CA_type_internal",
"title": "CA_type_internal",
"_required_": false
},
"CA_type_intermediate": {
"type": "boolean",
"_name_": "CA_type_intermediate",
"title": "CA_type_intermediate",
"_required_": false
},
"cert_type_existing": {
"type": "boolean",
"_name_": "cert_type_existing",
"title": "cert_type_existing",
"_required_": false
},
"cert_type_internal": {
"type": "boolean",
"_name_": "cert_type_internal",
"title": "cert_type_internal",
"_required_": false
},
"cert_type_CSR": {
"type": "boolean",
"_name_": "cert_type_CSR",
"title": "cert_type_CSR",
"_required_": false
},
"parsed": {
"type": "boolean",
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"can_be_revoked": {
"type": "boolean",
"_name_": "can_be_revoked",
"title": "can_be_revoked",
"_required_": false
},
"extensions": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extensions",
"title": "extensions",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"revoked_certs": {
"_name_": "revoked_certs",
"title": "revoked_certs",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"crl_path": {
"_name_": "crl_path",
"title": "crl_path",
"_required_": false,
"type": "string"
},
"signed_certificates": {
"type": "integer",
"_name_": "signed_certificates",
"title": "signed_certificates",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "certificateauthority_entry",
"title": "certificate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"certificate",
"privatekey",
"CSR",
"acme_uri",
"domains_authenticators",
"renew_days",
"revoked_date",
"signedby",
"root_path",
"acme",
"certificate_path",
"privatekey_path",
"csr_path",
"cert_type",
"revoked",
"expired",
"issuer",
"chain_list",
"country",
"state",
"city",
"organization",
"organizational_unit",
"san",
"email",
"DN",
"subject_name_hash",
"digest_algorithm",
"from",
"common",
"until",
"fingerprint",
"key_type",
"internal",
"lifetime",
"serial",
"key_length",
"add_to_trusted_store",
"chain",
"CA_type_existing",
"CA_type_internal",
"CA_type_intermediate",
"cert_type_existing",
"cert_type_internal",
"cert_type_CSR",
"parsed",
"can_be_revoked",
"extensions",
"revoked_certs",
"crl_path",
"signed_certificates"
]
}
]
Sent on cloud_backup changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"keep_last": {
"type": "integer",
"_name_": "keep_last",
"title": "keep_last",
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_backup_entry",
"title": "cloud_backup_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"password",
"keep_last",
"id",
"credentials",
"job",
"locked"
]
}
]
Sent on cloudsync changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": false,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"pre_script": {
"_name_": "pre_script",
"title": "pre_script",
"default": "",
"_required_": false,
"type": "string"
},
"post_script": {
"_name_": "post_script",
"title": "post_script",
"default": "",
"_required_": false,
"type": "string"
},
"snapshot": {
"type": "boolean",
"_name_": "snapshot",
"title": "snapshot",
"default": false,
"_required_": false
},
"bwlimit": {
"_name_": "bwlimit",
"title": "bwlimit",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"time": {
"_name_": "time",
"title": "time",
"_required_": false,
"type": "string"
},
"bandwidth": {
"type": [
"integer",
"null"
],
"_name_": "bandwidth",
"title": "bandwidth",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_bwlimit",
"title": "cloud_sync_bwlimit",
"default": {},
"_required_": false,
"_attrs_order_": [
"time",
"bandwidth"
]
}
]
},
"include": {
"_name_": "include",
"title": "include",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"exclude": {
"_name_": "exclude",
"title": "exclude",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"transfers": {
"type": [
"integer",
"null"
],
"_name_": "transfers",
"title": "transfers",
"default": null,
"_required_": false
},
"args": {
"_name_": "args",
"title": "args",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"direction": {
"_name_": "direction",
"title": "direction",
"_required_": true,
"type": "string",
"enum": [
"PUSH",
"PULL"
]
},
"transfer_mode": {
"_name_": "transfer_mode",
"title": "transfer_mode",
"_required_": true,
"type": "string",
"enum": [
"SYNC",
"COPY",
"MOVE"
]
},
"encryption": {
"type": "boolean",
"_name_": "encryption",
"title": "encryption",
"default": false,
"_required_": false
},
"filename_encryption": {
"type": "boolean",
"_name_": "filename_encryption",
"title": "filename_encryption",
"default": false,
"_required_": false
},
"encryption_password": {
"_name_": "encryption_password",
"title": "encryption_password",
"default": "",
"_required_": false,
"type": "string"
},
"encryption_salt": {
"_name_": "encryption_salt",
"title": "encryption_salt",
"default": "",
"_required_": false,
"type": "string"
},
"create_empty_src_dirs": {
"type": "boolean",
"_name_": "create_empty_src_dirs",
"title": "create_empty_src_dirs",
"default": false,
"_required_": false
},
"follow_symlinks": {
"type": "boolean",
"_name_": "follow_symlinks",
"title": "follow_symlinks",
"default": false,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "credentials",
"title": "credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cloud_sync_entry",
"title": "cloud_sync_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"description",
"path",
"attributes",
"schedule",
"pre_script",
"post_script",
"snapshot",
"bwlimit",
"include",
"exclude",
"transfers",
"args",
"enabled",
"direction",
"transfer_mode",
"encryption",
"filename_encryption",
"encryption_password",
"encryption_salt",
"create_empty_src_dirs",
"follow_symlinks",
"id",
"credentials",
"job",
"locked"
]
}
]
Sent on cloudsync.credentials changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
{
"minLength": 1,
"title": "name",
"type": "string",
"_name_": "name",
"_required_": true
},
{
"title": "provider",
"type": "string",
"_name_": "provider",
"_required_": true
},
{
"title": "attributes",
"type": "object",
"_name_": "attributes",
"_required_": true
}
]
Sent on cronjob changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": false
},
"stderr": {
"type": "boolean",
"_name_": "stderr",
"title": "stderr",
"default": false,
"_required_": false
},
"stdout": {
"type": "boolean",
"_name_": "stdout",
"title": "stdout",
"default": true,
"_required_": false
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"command": {
"_name_": "command",
"title": "command",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "cron_job_entry",
"title": "cron_job_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"enabled",
"stderr",
"stdout",
"schedule",
"command",
"description",
"user",
"id"
]
}
]
Sent on docker.network changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"ipam": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ipam",
"title": "ipam",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"labels": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "labels",
"title": "labels",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"created": {
"_name_": "created",
"title": "created",
"_required_": true,
"type": [
"string",
"null"
]
},
"driver": {
"_name_": "driver",
"title": "driver",
"_required_": true,
"type": [
"string",
"null"
]
},
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": [
"string",
"null"
]
},
"scope": {
"_name_": "scope",
"title": "scope",
"_required_": true,
"type": [
"string",
"null"
]
},
"short_id": {
"_name_": "short_id",
"title": "short_id",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": true,
"_name_": "docker_network_entry",
"title": "docker_network_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"ipam",
"labels",
"created",
"driver",
"id",
"name",
"scope",
"short_id"
]
}
]
Sent on enclosure changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "enclosure_entry",
"title": "enclosure_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on filesystem.acltemplate changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"acltype": {
"_name_": "acltype",
"title": "acltype",
"_required_": true,
"type": "string",
"enum": [
"NFS4",
"POSIX1E"
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"_required_": false,
"type": "string"
},
"acl": {
"anyOf": [
{
"_name_": "nfs4_acl",
"title": "nfs4_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"owner@",
"group@",
"everyone@",
"USER",
"GROUP"
]
},
"id": {
"type": [
"integer",
"null"
],
"_name_": "id",
"title": "id",
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"_required_": false,
"type": "string",
"enum": [
"ALLOW",
"DENY"
]
},
"perms": {
"type": "object",
"properties": {
"READ_DATA": {
"type": "boolean",
"_name_": "READ_DATA",
"title": "READ_DATA",
"_required_": false
},
"WRITE_DATA": {
"type": "boolean",
"_name_": "WRITE_DATA",
"title": "WRITE_DATA",
"_required_": false
},
"APPEND_DATA": {
"type": "boolean",
"_name_": "APPEND_DATA",
"title": "APPEND_DATA",
"_required_": false
},
"READ_NAMED_ATTRS": {
"type": "boolean",
"_name_": "READ_NAMED_ATTRS",
"title": "READ_NAMED_ATTRS",
"_required_": false
},
"WRITE_NAMED_ATTRS": {
"type": "boolean",
"_name_": "WRITE_NAMED_ATTRS",
"title": "WRITE_NAMED_ATTRS",
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"_required_": false
},
"DELETE_CHILD": {
"type": "boolean",
"_name_": "DELETE_CHILD",
"title": "DELETE_CHILD",
"_required_": false
},
"READ_ATTRIBUTES": {
"type": "boolean",
"_name_": "READ_ATTRIBUTES",
"title": "READ_ATTRIBUTES",
"_required_": false
},
"WRITE_ATTRIBUTES": {
"type": "boolean",
"_name_": "WRITE_ATTRIBUTES",
"title": "WRITE_ATTRIBUTES",
"_required_": false
},
"DELETE": {
"type": "boolean",
"_name_": "DELETE",
"title": "DELETE",
"_required_": false
},
"READ_ACL": {
"type": "boolean",
"_name_": "READ_ACL",
"title": "READ_ACL",
"_required_": false
},
"WRITE_ACL": {
"type": "boolean",
"_name_": "WRITE_ACL",
"title": "WRITE_ACL",
"_required_": false
},
"WRITE_OWNER": {
"type": "boolean",
"_name_": "WRITE_OWNER",
"title": "WRITE_OWNER",
"_required_": false
},
"SYNCHRONIZE": {
"type": "boolean",
"_name_": "SYNCHRONIZE",
"title": "SYNCHRONIZE",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"FULL_CONTROL",
"MODIFY",
"READ",
"TRAVERSE"
]
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ_DATA",
"WRITE_DATA",
"APPEND_DATA",
"READ_NAMED_ATTRS",
"WRITE_NAMED_ATTRS",
"EXECUTE",
"DELETE_CHILD",
"READ_ATTRIBUTES",
"WRITE_ATTRIBUTES",
"DELETE",
"READ_ACL",
"WRITE_ACL",
"WRITE_OWNER",
"SYNCHRONIZE",
"BASIC"
]
},
"flags": {
"type": "object",
"properties": {
"FILE_INHERIT": {
"type": "boolean",
"_name_": "FILE_INHERIT",
"title": "FILE_INHERIT",
"_required_": false
},
"DIRECTORY_INHERIT": {
"type": "boolean",
"_name_": "DIRECTORY_INHERIT",
"title": "DIRECTORY_INHERIT",
"_required_": false
},
"NO_PROPAGATE_INHERIT": {
"type": "boolean",
"_name_": "NO_PROPAGATE_INHERIT",
"title": "NO_PROPAGATE_INHERIT",
"_required_": false
},
"INHERIT_ONLY": {
"type": "boolean",
"_name_": "INHERIT_ONLY",
"title": "INHERIT_ONLY",
"_required_": false
},
"INHERITED": {
"type": "boolean",
"_name_": "INHERITED",
"title": "INHERITED",
"_required_": false
},
"BASIC": {
"_name_": "BASIC",
"title": "BASIC",
"_required_": false,
"type": "string",
"enum": [
"INHERIT",
"NOINHERIT"
]
}
},
"additionalProperties": false,
"_name_": "flags",
"title": "flags",
"default": {},
"_required_": false,
"_attrs_order_": [
"FILE_INHERIT",
"DIRECTORY_INHERIT",
"NO_PROPAGATE_INHERIT",
"INHERIT_ONLY",
"INHERITED",
"BASIC"
]
}
},
"additionalProperties": false,
"_name_": "nfs4_ace",
"title": "nfs4_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"id",
"type",
"perms",
"flags"
]
}
]
},
{
"_name_": "posix1e_acl",
"title": "posix1e_acl",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"default": {
"type": "boolean",
"_name_": "default",
"title": "default",
"default": false,
"_required_": false
},
"tag": {
"_name_": "tag",
"title": "tag",
"_required_": false,
"type": "string",
"enum": [
"USER_OBJ",
"GROUP_OBJ",
"USER",
"GROUP",
"OTHER",
"MASK"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"default": -1,
"_required_": false
},
"perms": {
"type": "object",
"properties": {
"READ": {
"type": "boolean",
"_name_": "READ",
"title": "READ",
"default": false,
"_required_": false
},
"WRITE": {
"type": "boolean",
"_name_": "WRITE",
"title": "WRITE",
"default": false,
"_required_": false
},
"EXECUTE": {
"type": "boolean",
"_name_": "EXECUTE",
"title": "EXECUTE",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "perms",
"title": "perms",
"default": {},
"_required_": false,
"_attrs_order_": [
"READ",
"WRITE",
"EXECUTE"
]
}
},
"additionalProperties": false,
"_name_": "posix1e_ace",
"title": "posix1e_ace",
"default": {},
"_required_": false,
"_attrs_order_": [
"default",
"tag",
"id",
"perms"
]
}
]
}
],
"nullable": false,
"_name_": "acl",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltemplate_entry",
"title": "acltemplate_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"acltype",
"comment",
"acl",
"id",
"builtin"
]
}
]
Sent on group changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
Sent on idmap changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"dns_domain_name": {
"_name_": "dns_domain_name",
"title": "dns_domain_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"range_low": {
"type": "integer",
"_name_": "range_low",
"title": "range_low",
"_required_": true
},
"range_high": {
"type": "integer",
"_name_": "range_high",
"title": "range_high",
"_required_": true
},
"idmap_backend": {
"_name_": "idmap_backend",
"title": "idmap_backend",
"_required_": true,
"type": "string",
"enum": [
"AD",
"AUTORID",
"LDAP",
"NSS",
"RFC2307",
"RID",
"TDB"
]
},
"certificate": {
"type": [
"integer",
"null"
],
"_name_": "certificate",
"title": "certificate",
"_required_": false
},
"options": {
"anyOf": [
{
"type": "object",
"properties": {
"schema_mode": {
"_name_": "schema_mode",
"title": "nss_info_ad",
"default": "SFU",
"_required_": false,
"type": "string",
"enum": [
"SFU",
"SFU20",
"RFC2307",
"TEMPLATE"
]
},
"unix_primary_group": {
"type": "boolean",
"_name_": "unix_primary_group",
"title": "unix_primary_group",
"default": false,
"_required_": false
},
"unix_nss_info": {
"type": "boolean",
"_name_": "unix_nss_info",
"title": "unix_nss_info",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ad_options",
"title": "idmap_ad_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"schema_mode",
"unix_primary_group",
"unix_nss_info"
]
},
{
"type": "object",
"properties": {
"rangesize": {
"type": "integer",
"_name_": "rangesize",
"title": "rangesize",
"default": 100000,
"_required_": false
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ignore_builtin": {
"type": "boolean",
"_name_": "ignore_builtin",
"title": "ignore_builtin",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_autorid_options",
"title": "idmap_autorid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"rangesize",
"readonly",
"ignore_builtin"
]
},
{
"type": "object",
"properties": {
"ldap_base_dn": {
"_name_": "ldap_base_dn",
"title": "ldap_base_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"readonly": {
"type": "boolean",
"_name_": "readonly",
"title": "readonly",
"default": false,
"_required_": false
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_ldap_options",
"title": "idmap_ldap_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_base_dn",
"ldap_user_dn",
"ldap_user_dn_password",
"ldap_url",
"readonly",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"linked_service": {
"_name_": "linked_service",
"title": "linked_service",
"default": "LOCAL_ACCOUNT",
"_required_": false,
"type": "string",
"enum": [
"LOCAL_ACCOUNT",
"LDAP"
]
}
},
"additionalProperties": false,
"_name_": "idmap_nss_options",
"title": "idmap_nss_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"linked_service"
]
},
{
"type": "object",
"properties": {
"ldap_server": {
"_name_": "ldap_server",
"title": "ldap_server",
"_required_": true,
"type": "string",
"enum": [
"AD",
"STANDALONE"
]
},
"ldap_realm": {
"type": "boolean",
"_name_": "ldap_realm",
"title": "ldap_realm",
"default": false,
"_required_": false
},
"bind_path_user": {
"_name_": "bind_path_user",
"title": "bind_path_user",
"_required_": false,
"type": "string"
},
"bind_path_group": {
"_name_": "bind_path_group",
"title": "bind_path_group",
"_required_": false,
"type": "string"
},
"user_cn": {
"type": "boolean",
"_name_": "user_cn",
"title": "user_cn",
"default": false,
"_required_": false
},
"cn_realm": {
"_name_": "cn_realm",
"title": "cn_realm",
"_required_": false,
"type": "string"
},
"ldap_domain": {
"_name_": "ldap_domain",
"title": "ldap_domain",
"_required_": false,
"type": "string"
},
"ldap_url": {
"_name_": "ldap_url",
"title": "ldap_url",
"_required_": false,
"type": "string"
},
"ldap_user_dn": {
"_name_": "ldap_user_dn",
"title": "ldap_user_dn",
"_required_": false,
"type": "string"
},
"ldap_user_dn_password": {
"_name_": "ldap_user_dn_password",
"title": "ldap_user_dn_password",
"_required_": false,
"type": "string"
},
"ssl": {
"_name_": "ssl",
"title": "ldap_ssl_choice",
"default": "ON",
"_required_": false,
"type": "string",
"enum": [
"OFF",
"ON",
"START_TLS"
]
},
"validate_certificates": {
"type": "boolean",
"_name_": "validate_certificates",
"title": "validate_certificates",
"default": true,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rfc2307_options",
"title": "idmap_rfc2307_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"ldap_server",
"ldap_realm",
"bind_path_user",
"bind_path_group",
"user_cn",
"cn_realm",
"ldap_domain",
"ldap_url",
"ldap_user_dn",
"ldap_user_dn_password",
"ssl",
"validate_certificates"
]
},
{
"type": "object",
"properties": {
"sssd_compat": {
"type": "boolean",
"_name_": "sssd_compat",
"title": "sssd_compat",
"default": false,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_rid_options",
"title": "idmap_rid_options",
"default": {},
"_required_": false,
"_attrs_order_": [
"sssd_compat"
]
},
{
"type": "object",
"properties": {},
"additionalProperties": false,
"_name_": "idmap_tdb_options",
"title": "idmap_tdb_options",
"default": {},
"_required_": false,
"_attrs_order_": []
}
],
"nullable": false,
"_name_": "options",
"description": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "idmap_domain_entry",
"title": "idmap_domain_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"dns_domain_name",
"range_low",
"range_high",
"idmap_backend",
"certificate",
"options",
"id"
]
}
]
Sent on initshutdownscript changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"COMMAND",
"SCRIPT"
]
},
"command": {
"_name_": "command",
"title": "command",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"script": {
"_name_": "script",
"title": "script",
"default": "",
"_required_": false,
"type": [
"string",
"null"
]
},
"when": {
"_name_": "when",
"title": "when",
"_required_": true,
"type": "string",
"enum": [
"PREINIT",
"POSTINIT",
"SHUTDOWN"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"timeout": {
"type": "integer",
"_name_": "timeout",
"title": "timeout",
"default": 10,
"_required_": false
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "init_shutdown_script_entry",
"title": "init_shutdown_script_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"command",
"script",
"when",
"enabled",
"timeout",
"comment",
"id"
]
}
]
Sent on interface changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"fake": {
"type": "boolean",
"_name_": "fake",
"title": "fake",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"state": {
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"orig_name": {
"_name_": "orig_name",
"title": "orig_name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": "integer",
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"cloned": {
"type": "boolean",
"_name_": "cloned",
"title": "cloned",
"_required_": true
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
},
"nd6_flags": {
"_name_": "nd6_flags",
"title": "nd6_flags",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"capabilities": {
"_name_": "capabilities",
"title": "capabilities",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"link_state": {
"_name_": "link_state",
"title": "link_state",
"_required_": true,
"type": "string"
},
"media_type": {
"_name_": "media_type",
"title": "media_type",
"_required_": true,
"type": "string"
},
"media_subtype": {
"_name_": "media_subtype",
"title": "media_subtype",
"_required_": true,
"type": "string"
},
"active_media_type": {
"_name_": "active_media_type",
"title": "active_media_type",
"_required_": true,
"type": "string"
},
"active_media_subtype": {
"_name_": "active_media_subtype",
"title": "active_media_subtype",
"_required_": true,
"type": "string"
},
"supported_media": {
"_name_": "supported_media",
"title": "supported_media",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"media_options": {
"_name_": "media_options",
"title": "media_options",
"default": [],
"_required_": true,
"type": [
"array",
"null"
],
"items": []
},
"link_address": {
"_name_": "link_address",
"title": "link_address",
"_required_": true,
"type": "string"
},
"permanent_link_address": {
"_name_": "permanent_link_address",
"title": "permanent_link_address",
"_required_": true,
"type": [
"string",
"null"
]
},
"hardware_link_address": {
"_name_": "hardware_link_address",
"title": "hardware_link_address",
"_required_": true,
"type": "string"
},
"rx_queues": {
"type": "integer",
"_name_": "rx_queues",
"title": "rx_queues",
"_required_": true
},
"tx_queues": {
"type": "integer",
"_name_": "tx_queues",
"title": "tx_queues",
"_required_": true
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": false,
"type": "string"
},
"broadcast": {
"_name_": "broadcast",
"title": "broadcast",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask",
"broadcast"
]
}
]
},
"vrrp_config": {
"_name_": "vrrp_config",
"title": "vrrp_config",
"default": [],
"_required_": false,
"type": [
"array",
"null"
],
"items": []
},
"protocol": {
"_name_": "protocol",
"title": "protocol",
"_required_": false,
"type": [
"string",
"null"
]
},
"ports": {
"_name_": "ports",
"title": "ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"flags": {
"_name_": "flags",
"title": "flags",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "flag",
"title": "flag",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "lag_ports",
"title": "lag_ports",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"flags"
]
}
]
},
"xmit_hash_policy": {
"_name_": "xmit_hash_policy",
"title": "xmit_hash_policy",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"lacpdu_rate": {
"_name_": "lacpdu_rate",
"title": "lacpdu_rate",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"parent": {
"_name_": "parent",
"title": "parent",
"_required_": false,
"type": [
"string",
"null"
]
},
"tag": {
"type": [
"integer",
"null"
],
"_name_": "tag",
"title": "tag",
"_required_": false
},
"pcp": {
"type": [
"integer",
"null"
],
"_name_": "pcp",
"title": "pcp",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "state",
"title": "state",
"default": {},
"_required_": true,
"_attrs_order_": [
"name",
"orig_name",
"description",
"mtu",
"cloned",
"flags",
"nd6_flags",
"capabilities",
"link_state",
"media_type",
"media_subtype",
"active_media_type",
"active_media_subtype",
"supported_media",
"media_options",
"link_address",
"permanent_link_address",
"hardware_link_address",
"rx_queues",
"tx_queues",
"aliases",
"vrrp_config",
"protocol",
"ports",
"xmit_hash_policy",
"lacpdu_rate",
"parent",
"tag",
"pcp"
]
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": true,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"address": {
"_name_": "address",
"title": "address",
"_required_": true,
"type": "string"
},
"netmask": {
"_name_": "netmask",
"title": "netmask",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "alias",
"title": "alias",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"address",
"netmask"
]
}
]
},
"ipv4_dhcp": {
"type": "boolean",
"_name_": "ipv4_dhcp",
"title": "ipv4_dhcp",
"_required_": true
},
"ipv6_auto": {
"type": "boolean",
"_name_": "ipv6_auto",
"title": "ipv6_auto",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"mtu": {
"type": [
"integer",
"null"
],
"_name_": "mtu",
"title": "mtu",
"_required_": true
},
"vlan_parent_interface": {
"_name_": "vlan_parent_interface",
"title": "vlan_parent_interface",
"_required_": false,
"type": [
"string",
"null"
]
},
"vlan_tag": {
"type": [
"integer",
"null"
],
"_name_": "vlan_tag",
"title": "vlan_tag",
"_required_": false
},
"vlan_pcp": {
"type": [
"integer",
"null"
],
"_name_": "vlan_pcp",
"title": "vlan_pcp",
"_required_": false
},
"lag_protocol": {
"_name_": "lag_protocol",
"title": "lag_protocol",
"_required_": false,
"type": "string"
},
"lag_ports": {
"_name_": "lag_ports",
"title": "lag_ports",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "lag_port",
"title": "lag_port",
"_required_": false,
"type": "string"
}
]
},
"bridge_members": {
"_name_": "bridge_members",
"title": "bridge_members",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "member",
"title": "member",
"_required_": false,
"type": "string"
}
]
},
"enable_learning": {
"type": "boolean",
"_name_": "enable_learning",
"title": "enable_learning",
"_required_": false
}
},
"additionalProperties": true,
"_name_": "interface_entry",
"title": "interface_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"fake",
"type",
"state",
"aliases",
"ipv4_dhcp",
"ipv6_auto",
"description",
"mtu",
"vlan_parent_interface",
"vlan_tag",
"vlan_pcp",
"lag_protocol",
"lag_ports",
"bridge_members",
"enable_learning"
]
}
]
Sent on ipmi.lan changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"channel": {
"type": "integer",
"_name_": "channel",
"title": "channel",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ip_address_source": {
"_name_": "ip_address_source",
"title": "ip_address_source",
"_required_": false,
"type": "string"
},
"ip_address": {
"_name_": "ip_address",
"title": "ip_address",
"_required_": false,
"type": "string"
},
"mac_address": {
"_name_": "mac_address",
"title": "mac_address",
"_required_": false,
"type": "string"
},
"subnet_mask": {
"_name_": "subnet_mask",
"title": "subnet_mask",
"_required_": false,
"type": "string"
},
"default_gateway_ip_address": {
"_name_": "default_gateway_ip_address",
"title": "default_gateway_ip_address",
"_required_": false,
"type": "string"
},
"default_gateway_mac_address": {
"_name_": "default_gateway_mac_address",
"title": "default_gateway_mac_address",
"_required_": false,
"type": "string"
},
"backup_gateway_ip_address": {
"_name_": "backup_gateway_ip_address",
"title": "backup_gateway_ip_address",
"_required_": false,
"type": "string"
},
"backup_gateway_mac_address": {
"_name_": "backup_gateway_mac_address",
"title": "backup_gateway_mac_address",
"_required_": false,
"type": "string"
},
"vlan_id": {
"type": "integer",
"_name_": "vlan_id",
"title": "vlan_id",
"_required_": false
},
"vlan_id_enable": {
"type": "boolean",
"_name_": "vlan_id_enable",
"title": "vlan_id_enable",
"_required_": false
},
"vlan_priority": {
"type": "integer",
"_name_": "vlan_priority",
"title": "vlan_priority",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ipmi_channel",
"title": "ipmi_channel",
"default": {},
"_required_": false,
"_attrs_order_": [
"channel",
"id",
"ip_address_source",
"ip_address",
"mac_address",
"subnet_mask",
"default_gateway_ip_address",
"default_gateway_mac_address",
"backup_gateway_ip_address",
"backup_gateway_mac_address",
"vlan_id",
"vlan_id_enable",
"vlan_priority"
]
}
]
Sent on iscsi.auth changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"tag": {
"type": "integer",
"_name_": "tag",
"title": "tag",
"_required_": true
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"secret": {
"_name_": "secret",
"title": "secret",
"_required_": true,
"type": "string"
},
"peeruser": {
"_name_": "peeruser",
"title": "peeruser",
"default": "",
"_required_": false,
"type": "string"
},
"peersecret": {
"_name_": "peersecret",
"title": "peersecret",
"default": "",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "iscsi_auth_entry",
"title": "iscsi_auth_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"tag",
"user",
"secret",
"peeruser",
"peersecret",
"id"
]
}
]
Sent on iscsi.extent changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_extent_entry",
"title": "iscsi_extent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on iscsi.host changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_host_entry",
"title": "iscsi_host_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on iscsi.initiator changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_initiator_entry",
"title": "iscsi_initiator_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on iscsi.portal changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_portal_entry",
"title": "iscsi_portal_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on iscsi.target changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_target_entry",
"title": "iscsi_target_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on iscsi.targetextent changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "iscsi_targetextent_entry",
"title": "iscsi_targetextent_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on jbof changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"mgmt_ip1": {
"_name_": "mgmt_ip1",
"title": "mgmt_ip1",
"_required_": true,
"type": "string"
},
"mgmt_ip2": {
"_name_": "mgmt_ip2",
"title": "mgmt_ip2",
"_required_": false,
"type": "string"
},
"mgmt_username": {
"_name_": "mgmt_username",
"title": "mgmt_username",
"_required_": true,
"type": "string"
},
"mgmt_password": {
"_name_": "mgmt_password",
"title": "mgmt_password",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "jbof_entry",
"title": "jbof_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"description",
"mgmt_ip1",
"mgmt_ip2",
"mgmt_username",
"mgmt_password"
]
}
]
Sent on kerberos.keytab changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"file": {
"_name_": "file",
"title": "file",
"_required_": false,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": false,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_keytab_entry",
"title": "kerberos_keytab_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"file",
"name",
"id"
]
}
]
Sent on kerberos.realm changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"realm": {
"_name_": "realm",
"title": "realm",
"_required_": true,
"type": "string"
},
"kdc": {
"_name_": "kdc",
"title": "kdc",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"admin_server": {
"_name_": "admin_server",
"title": "admin_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"kpasswd_server": {
"_name_": "kpasswd_server",
"title": "kpasswd_server",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "kerberos_realm_entry",
"title": "kerberos_realm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"realm",
"kdc",
"admin_server",
"kpasswd_server",
"id"
]
}
]
Sent on keychaincredential changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "keychain_credential_entry",
"title": "keychain_credential_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"name",
"type",
"attributes",
"id"
]
}
]
Sent on pool changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"guid": {
"_name_": "guid",
"title": "guid",
"_required_": true,
"type": "string"
},
"status": {
"_name_": "status",
"title": "status",
"_required_": true,
"type": "string"
},
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"scan": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "scan",
"title": "scan",
"description": "\n\nExample(s):\n```\n{\n \"function\": null,\n \"state\": null,\n \"start_time\": null,\n \"end_time\": null,\n \"percentage\": null,\n \"bytes_to_process\": null,\n \"bytes_processed\": null,\n \"bytes_issued\": null,\n \"pause\": null,\n \"errors\": null,\n \"total_secs_left\": null\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"expand": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "expand",
"title": "expand",
"description": "\n\nExample(s):\n```\n{\n \"state\": \"FINISHED\",\n \"expanding_vdev\": 0,\n \"start_time\": null,\n \"end_time\": null,\n \"bytes_to_reflow\": 835584,\n \"bytes_reflowed\": 978944,\n \"waiting_for_resilver\": 0,\n \"total_secs_left\": null,\n \"percentage\": 85.35564853556485\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"is_upgraded": {
"type": "boolean",
"_name_": "is_upgraded",
"title": "is_upgraded",
"_required_": false
},
"healthy": {
"type": "boolean",
"_name_": "healthy",
"title": "healthy",
"_required_": true
},
"warning": {
"type": "boolean",
"_name_": "warning",
"title": "warning",
"_required_": true
},
"status_code": {
"_name_": "status_code",
"title": "status_code",
"_required_": true,
"type": [
"string",
"null"
]
},
"status_detail": {
"_name_": "status_detail",
"title": "status_detail",
"_required_": true,
"type": [
"string",
"null"
]
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"_required_": true
},
"allocated": {
"type": [
"integer",
"null"
],
"_name_": "allocated",
"title": "allocated",
"_required_": true
},
"free": {
"type": [
"integer",
"null"
],
"_name_": "free",
"title": "free",
"_required_": true
},
"freeing": {
"type": [
"integer",
"null"
],
"_name_": "freeing",
"title": "freeing",
"_required_": true
},
"fragmentation": {
"_name_": "fragmentation",
"title": "fragmentation",
"_required_": true,
"type": [
"string",
"null"
]
},
"size_str": {
"_name_": "size_str",
"title": "size_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"allocated_str": {
"_name_": "allocated_str",
"title": "allocated_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"free_str": {
"_name_": "free_str",
"title": "free_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"freeing_str": {
"_name_": "freeing_str",
"title": "freeing_str",
"_required_": true,
"type": [
"string",
"null"
]
},
"autotrim": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "autotrim",
"title": "autotrim",
"description": "\n\nExample(s):\n```\n{\n \"parsed\": \"off\",\n \"rawvalue\": \"off\",\n \"source\": \"DEFAULT\",\n \"value\": \"off\"\n}\n```\n",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"topology": {
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"log": {
"_name_": "log",
"title": "log",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"cache": {
"_name_": "cache",
"title": "cache",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"spare": {
"_name_": "spare",
"title": "spare",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"special": {
"_name_": "special",
"title": "special",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"dedup": {
"_name_": "dedup",
"title": "dedup",
"default": [],
"_required_": true,
"type": "array",
"items": []
}
},
"additionalProperties": false,
"_name_": "topology",
"title": "topology",
"default": {},
"_required_": true,
"_attrs_order_": [
"data",
"log",
"cache",
"spare",
"special",
"dedup"
]
}
},
"additionalProperties": false,
"_name_": "pool_entry",
"title": "pool_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"name",
"guid",
"status",
"path",
"scan",
"expand",
"is_upgraded",
"healthy",
"warning",
"status_code",
"status_detail",
"size",
"allocated",
"free",
"freeing",
"fragmentation",
"size_str",
"allocated_str",
"free_str",
"freeing_str",
"autotrim",
"topology"
]
}
]
Sent on pool.dataset changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string"
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"pool": {
"_name_": "pool",
"title": "pool",
"_required_": true,
"type": "string"
},
"encrypted": {
"type": "boolean",
"_name_": "encrypted",
"title": "encrypted",
"_required_": false
},
"encryption_root": {
"_name_": "encryption_root",
"title": "encryption_root",
"_required_": false,
"type": [
"string",
"null"
]
},
"key_loaded": {
"type": [
"boolean",
"null"
],
"_name_": "key_loaded",
"title": "key_loaded",
"_required_": false
},
"children": {
"_name_": "children",
"title": "children",
"default": [],
"_required_": true,
"type": "array",
"items": []
},
"user_properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "user_properties",
"title": "user_properties",
"default": {},
"_required_": true,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"comments": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "comments",
"title": "comments",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_warning",
"title": "quota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota_critical",
"title": "quota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_warning": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_warning",
"title": "refquota_warning",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota_critical": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota_critical",
"title": "refquota_critical",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"managedby": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "managedby",
"title": "managedby",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"deduplication": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "deduplication",
"title": "deduplication",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"aclmode": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "aclmode",
"title": "aclmode",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"acltype": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "acltype",
"title": "acltype",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"xattr": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "xattr",
"title": "xattr",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"atime": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "atime",
"title": "atime",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"casesensitivity": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "casesensitivity",
"title": "casesensitivity",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"checksum": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "checksum",
"title": "checksum",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"exec": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "exec",
"title": "exec",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sync": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sync",
"title": "sync",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compression": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compression",
"title": "compression",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"compressratio": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "compressratio",
"title": "compressratio",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"origin": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "origin",
"title": "origin",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"quota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "quota",
"title": "quota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refquota": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refquota",
"title": "refquota",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"reservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "reservation",
"title": "reservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"refreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "refreservation",
"title": "refreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"copies": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "copies",
"title": "copies",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdir": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdir",
"title": "snapdir",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"readonly": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "readonly",
"title": "readonly",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"recordsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "recordsize",
"title": "recordsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"sparse": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sparse",
"title": "sparse",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volsize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volsize",
"title": "volsize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"volblocksize": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "volblocksize",
"title": "volblocksize",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"key_format": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "key_format",
"title": "key_format",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"encryption_algorithm": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "encryption_algorithm",
"title": "encryption_algorithm",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"used": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "used",
"title": "used",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbychildren": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbychildren",
"title": "usedbychildren",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbydataset": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbydataset",
"title": "usedbydataset",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbyrefreservation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbyrefreservation",
"title": "usedbyrefreservation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"usedbysnapshots": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "usedbysnapshots",
"title": "usedbysnapshots",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"available": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "available",
"title": "available",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"special_small_block_size": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "special_small_block_size",
"title": "special_small_block_size",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"pbkdf2iters": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "pbkdf2iters",
"title": "pbkdf2iters",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"creation": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "creation",
"title": "creation",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"snapdev": {
"type": "object",
"properties": {
"parsed": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "parsed",
"title": "parsed",
"_required_": false
},
"rawvalue": {
"_name_": "rawvalue",
"title": "rawvalue",
"_required_": false,
"type": [
"string",
"null"
]
},
"value": {
"_name_": "value",
"title": "value",
"_required_": false,
"type": [
"string",
"null"
]
},
"source": {
"_name_": "source",
"title": "source",
"_required_": false,
"type": [
"string",
"null"
]
},
"source_info": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "source_info",
"title": "source_info",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "snapdev",
"title": "snapdev",
"default": {},
"_required_": false,
"_attrs_order_": [
"parsed",
"rawvalue",
"value",
"source",
"source_info"
]
},
"mountpoint": {
"_name_": "mountpoint",
"title": "mountpoint",
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "pool_dataset_entry",
"title": "pool_dataset_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"type",
"name",
"pool",
"encrypted",
"encryption_root",
"key_loaded",
"children",
"user_properties",
"locked",
"comments",
"quota_warning",
"quota_critical",
"refquota_warning",
"refquota_critical",
"managedby",
"deduplication",
"aclmode",
"acltype",
"xattr",
"atime",
"casesensitivity",
"checksum",
"exec",
"sync",
"compression",
"compressratio",
"origin",
"quota",
"refquota",
"reservation",
"refreservation",
"copies",
"snapdir",
"readonly",
"recordsize",
"sparse",
"volsize",
"volblocksize",
"key_format",
"encryption_algorithm",
"used",
"usedbychildren",
"usedbydataset",
"usedbyrefreservation",
"usedbysnapshots",
"available",
"special_small_block_size",
"pbkdf2iters",
"creation",
"snapdev",
"mountpoint"
]
}
]
Sent on pool.dataset.userprop changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"_name_": "id",
"title": "id",
"_required_": true,
"type": "string"
},
"properties": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "properties",
"title": "properties",
"default": {},
"_required_": true,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "pool_dataset_userprop_entry",
"title": "pool_dataset_userprop_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"properties"
]
}
]
Sent on pool.scrub changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"pool": {
"type": "integer",
"_name_": "pool",
"title": "pool",
"_required_": true
},
"threshold": {
"type": "integer",
"_name_": "threshold",
"title": "threshold",
"_required_": true
},
"description": {
"_name_": "description",
"title": "description",
"_required_": true,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "00",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "7",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": true,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": true
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"pool_name": {
"_name_": "pool_name",
"title": "pool_name",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "pool_scrub_entry",
"title": "pool_scrub_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"pool",
"threshold",
"description",
"schedule",
"enabled",
"id",
"pool_name"
]
}
]
Sent on pool.snapshottask changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "pool_snapshottask_entry",
"title": "pool_snapshottask_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on privilege changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"builtin_name": {
"_name_": "builtin_name",
"title": "builtin_name",
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"local_groups": {
"_name_": "local_groups",
"title": "local_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"ds_groups": {
"_name_": "ds_groups",
"title": "ds_groups",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"gid": {
"type": "integer",
"_name_": "gid",
"title": "gid",
"_required_": false
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"smb": {
"type": "boolean",
"_name_": "smb",
"title": "smb",
"default": true,
"_required_": false
},
"sudo_commands": {
"_name_": "sudo_commands",
"title": "sudo_commands",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"sudo_commands_nopasswd": {
"_name_": "sudo_commands_nopasswd",
"title": "sudo_commands_nopasswd",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "command",
"title": "command",
"_required_": false,
"type": "string"
}
]
},
"users": {
"_name_": "users",
"title": "users",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"group": {
"_name_": "group",
"title": "group",
"_required_": false,
"type": "string"
},
"builtin": {
"type": "boolean",
"_name_": "builtin",
"title": "builtin",
"_required_": false
},
"id_type_both": {
"type": "boolean",
"_name_": "id_type_both",
"title": "id_type_both",
"_required_": false
},
"local": {
"type": "boolean",
"_name_": "local",
"title": "local",
"_required_": false
},
"sid": {
"_name_": "sid",
"title": "sid",
"_required_": false,
"type": [
"string",
"null"
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
}
},
"additionalProperties": false,
"_name_": "group_entry",
"title": "group_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"gid",
"name",
"smb",
"sudo_commands",
"sudo_commands_nopasswd",
"users",
"id",
"group",
"builtin",
"id_type_both",
"local",
"sid",
"roles"
]
}
]
},
"allowlist": {
"_name_": "allowlist",
"title": "allowlist",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"method": {
"_name_": "method",
"title": "method",
"_required_": true,
"type": "string",
"enum": [
"GET",
"POST",
"PUT",
"DELETE",
"CALL",
"SUBSCRIBE",
"*"
]
},
"resource": {
"_name_": "resource",
"title": "resource",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "allowlist_item",
"title": "allowlist_item",
"default": {},
"_required_": false,
"_attrs_order_": [
"method",
"resource"
]
}
]
},
"roles": {
"_name_": "roles",
"title": "roles",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "role",
"title": "role",
"_required_": false,
"type": "string"
}
]
},
"web_shell": {
"type": "boolean",
"_name_": "web_shell",
"title": "web_shell",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "privilege_entry",
"title": "privilege_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"builtin_name",
"name",
"local_groups",
"ds_groups",
"allowlist",
"roles",
"web_shell"
]
}
]
Sent on replication changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "replication_entry",
"title": "replication_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on reporting.exporters changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"_required_": true
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"GRAPHITE"
]
},
"attributes": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "attributes",
"title": "attributes",
"description": "Specific attributes of each `exporter`",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"name": {
"_name_": "name",
"title": "name",
"description": "User defined name of exporter configuration",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "reporting_exporter_entry",
"title": "reporting_exporter_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"enabled",
"type",
"attributes",
"name"
]
}
]
Sent on rsynctask changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"user": {
"_name_": "user",
"title": "user",
"_required_": true,
"type": "string"
},
"mode": {
"_name_": "mode",
"title": "mode",
"default": "MODULE",
"_required_": false,
"type": "string",
"enum": [
"MODULE",
"SSH"
]
},
"remotehost": {
"_name_": "remotehost",
"title": "remotehost",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remoteport": {
"type": [
"integer",
"null"
],
"_name_": "remoteport",
"title": "remoteport",
"default": null,
"_required_": false
},
"remotemodule": {
"_name_": "remotemodule",
"title": "remotemodule",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"remotepath": {
"_name_": "remotepath",
"title": "remotepath",
"_required_": false,
"type": "string"
},
"direction": {
"_name_": "direction",
"title": "direction",
"default": "PUSH",
"_required_": false,
"type": "string",
"enum": [
"PULL",
"PUSH"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"schedule": {
"type": "object",
"properties": {
"minute": {
"_name_": "minute",
"title": "minute",
"default": "00",
"_required_": false,
"type": "string"
},
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"minute",
"hour",
"dom",
"month",
"dow"
]
},
"recursive": {
"type": "boolean",
"_name_": "recursive",
"title": "recursive",
"_required_": false
},
"times": {
"type": "boolean",
"_name_": "times",
"title": "times",
"_required_": false
},
"compress": {
"type": "boolean",
"_name_": "compress",
"title": "compress",
"_required_": false
},
"archive": {
"type": "boolean",
"_name_": "archive",
"title": "archive",
"_required_": false
},
"delete": {
"type": "boolean",
"_name_": "delete",
"title": "delete",
"_required_": false
},
"quiet": {
"type": "boolean",
"_name_": "quiet",
"title": "quiet",
"_required_": false
},
"preserveperm": {
"type": "boolean",
"_name_": "preserveperm",
"title": "preserveperm",
"_required_": false
},
"preserveattr": {
"type": "boolean",
"_name_": "preserveattr",
"title": "preserveattr",
"_required_": false
},
"delayupdates": {
"type": "boolean",
"_name_": "delayupdates",
"title": "delayupdates",
"_required_": false
},
"extra": {
"_name_": "extra",
"title": "extra",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "extra",
"title": "extra",
"_required_": false,
"type": "string"
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"ssh_credentials": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "ssh_credentials",
"title": "ssh_credentials",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
},
"job": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "job",
"title": "job",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "rsync_task_entry",
"title": "rsync_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"user",
"mode",
"remotehost",
"remoteport",
"remotemodule",
"remotepath",
"direction",
"desc",
"schedule",
"recursive",
"times",
"compress",
"archive",
"delete",
"quiet",
"preserveperm",
"preserveattr",
"delayupdates",
"extra",
"enabled",
"id",
"ssh_credentials",
"locked",
"job"
]
}
]
Sent on service changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"service": {
"_name_": "service",
"title": "service",
"_required_": false,
"type": "string"
},
"enable": {
"type": "boolean",
"_name_": "enable",
"title": "enable",
"_required_": false
},
"state": {
"_name_": "state",
"title": "state",
"_required_": false,
"type": "string"
},
"pids": {
"_name_": "pids",
"title": "pids",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "integer",
"_name_": "pid",
"title": "pid",
"_required_": false
}
]
}
},
"additionalProperties": false,
"_name_": "service_entry",
"title": "service_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"id",
"service",
"enable",
"state",
"pids"
]
}
]
Sent on sharing.nfs changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"aliases": {
"_name_": "aliases",
"title": "aliases",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
}
]
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "network",
"title": "network",
"_required_": false,
"type": "string"
}
]
},
"hosts": {
"_name_": "hosts",
"title": "hosts",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "host",
"title": "host",
"_required_": false,
"type": "string"
}
]
},
"ro": {
"type": "boolean",
"_name_": "ro",
"title": "ro",
"default": false,
"_required_": false
},
"maproot_user": {
"_name_": "maproot_user",
"title": "maproot_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"maproot_group": {
"_name_": "maproot_group",
"title": "maproot_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_user": {
"_name_": "mapall_user",
"title": "mapall_user",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mapall_group": {
"_name_": "mapall_group",
"title": "mapall_group",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"security": {
"_name_": "security",
"title": "security",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "provider",
"title": "provider",
"_required_": false,
"type": "string",
"enum": [
"SYS",
"KRB5",
"KRB5I",
"KRB5P"
]
}
]
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"locked": {
"type": "boolean",
"_name_": "locked",
"title": "locked",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "sharing_nfs_entry",
"title": "sharing_nfs_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"aliases",
"comment",
"networks",
"hosts",
"ro",
"maproot_user",
"maproot_group",
"mapall_user",
"mapall_group",
"security",
"enabled",
"id",
"locked"
]
}
]
Sent on sharing.smb changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "sharing_smb_entry",
"title": "sharing_smb_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Sent on smart.test changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"schedule": {
"type": "object",
"properties": {
"hour": {
"_name_": "hour",
"title": "hour",
"default": "*",
"_required_": false,
"type": "string"
},
"dom": {
"_name_": "dom",
"title": "dom",
"default": "*",
"_required_": false,
"type": "string"
},
"month": {
"_name_": "month",
"title": "month",
"default": "*",
"_required_": false,
"type": "string"
},
"dow": {
"_name_": "dow",
"title": "dow",
"default": "*",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "schedule",
"title": "schedule",
"default": {},
"_required_": false,
"_attrs_order_": [
"hour",
"dom",
"month",
"dow"
]
},
"desc": {
"_name_": "desc",
"title": "desc",
"_required_": false,
"type": "string"
},
"all_disks": {
"type": "boolean",
"_name_": "all_disks",
"title": "all_disks",
"default": false,
"_required_": false
},
"disks": {
"_name_": "disks",
"title": "disks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"_name_": "disk",
"title": "disk",
"_required_": false,
"type": "string"
}
]
},
"type": {
"_name_": "type",
"title": "type",
"_required_": true,
"type": "string",
"enum": [
"LONG",
"SHORT",
"CONVEYANCE",
"OFFLINE"
]
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "smart_task_entry",
"title": "smart_task_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"schedule",
"desc",
"all_disks",
"disks",
"type",
"id"
]
}
]
Sent on staticroute changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"destination": {
"_name_": "destination",
"title": "destination",
"_required_": true,
"type": "string"
},
"gateway": {
"_name_": "gateway",
"title": "gateway",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"default": "",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": true
}
},
"additionalProperties": false,
"_name_": "staticroute_entry",
"title": "staticroute_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"destination",
"gateway",
"description",
"id"
]
}
]
Sent on system.ntpserver changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"address": {
"_name_": "address",
"title": "address",
"_required_": false,
"type": "string"
},
"burst": {
"type": "boolean",
"_name_": "burst",
"title": "burst",
"default": false,
"_required_": false
},
"iburst": {
"type": "boolean",
"_name_": "iburst",
"title": "iburst",
"default": true,
"_required_": false
},
"prefer": {
"type": "boolean",
"_name_": "prefer",
"title": "prefer",
"default": false,
"_required_": false
},
"minpoll": {
"type": "integer",
"_name_": "minpoll",
"title": "minpoll",
"default": 6,
"_required_": false
},
"maxpoll": {
"type": "integer",
"_name_": "maxpoll",
"title": "maxpoll",
"default": 10,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "ntp_entry",
"title": "ntp_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"address",
"burst",
"iburst",
"prefer",
"minpoll",
"maxpoll",
"id"
]
}
]
Sent on tunable changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"type": {
"_name_": "type",
"title": "type",
"default": "SYSCTL",
"_required_": true,
"type": "string",
"enum": [
"SYSCTL",
"UDEV",
"ZFS"
]
},
"var": {
"_name_": "var",
"title": "var",
"_required_": true,
"type": "string"
},
"value": {
"_name_": "value",
"title": "value",
"_required_": true,
"type": "string"
},
"comment": {
"_name_": "comment",
"title": "comment",
"default": "",
"_required_": false,
"type": "string"
},
"enabled": {
"type": "boolean",
"_name_": "enabled",
"title": "enabled",
"default": true,
"_required_": false
},
"update_initramfs": {
"type": "boolean",
"_name_": "update_initramfs",
"title": "update_initramfs",
"default": true,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"orig_value": {
"_name_": "orig_value",
"title": "orig_value",
"_required_": false,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "tunable_entry",
"title": "tunable_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"type",
"var",
"value",
"comment",
"enabled",
"update_initramfs",
"id",
"orig_value"
]
}
]
Sent on user changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"title": "id",
"type": "integer",
"_name_": "id",
"_required_": true
},
{
"title": "uid",
"type": "integer",
"_name_": "uid",
"_required_": true
},
{
"title": "username",
"type": "string",
"_name_": "username",
"_required_": true
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "unixhash",
"_name_": "unixhash",
"_required_": true
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "smbhash",
"_name_": "smbhash",
"_required_": true
},
{
"default": "/var/empty",
"minLength": 1,
"title": "home",
"type": "string",
"_name_": "home",
"_required_": false
},
{
"default": "/usr/bin/zsh",
"minLength": 1,
"title": "shell",
"type": "string",
"_name_": "shell",
"_required_": false
},
{
"title": "full_name",
"type": "string",
"_name_": "full_name",
"_required_": true
},
{
"title": "builtin",
"type": "boolean",
"_name_": "builtin",
"_required_": true
},
{
"default": true,
"title": "smb",
"type": "boolean",
"_name_": "smb",
"_required_": false
},
{
"title": "group",
"type": "object",
"_name_": "group",
"_required_": true
},
{
"default": [],
"items": [
{
"type": "integer"
}
],
"title": "groups",
"type": "array",
"_name_": "groups",
"_required_": false
},
{
"default": false,
"title": "password_disabled",
"type": "boolean",
"_name_": "password_disabled",
"_required_": false
},
{
"default": false,
"title": "ssh_password_enabled",
"type": "boolean",
"_name_": "ssh_password_enabled",
"_required_": false
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "sshpubkey",
"_name_": "sshpubkey",
"_required_": false
},
{
"default": false,
"title": "locked",
"type": "boolean",
"_name_": "locked",
"_required_": false
},
{
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands",
"type": "array",
"_name_": "sudo_commands",
"_required_": false
},
{
"default": [],
"items": [
{
"minLength": 1,
"type": "string"
}
],
"title": "sudo_commands_nopasswd",
"type": "array",
"_name_": "sudo_commands_nopasswd",
"_required_": false
},
{
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "email",
"_name_": "email",
"_required_": false
},
{
"title": "id_type_both",
"type": "boolean",
"_name_": "id_type_both",
"_required_": true
},
{
"title": "local",
"type": "boolean",
"_name_": "local",
"_required_": true
},
{
"title": "immutable",
"type": "boolean",
"_name_": "immutable",
"_required_": true
},
{
"title": "twofactor_auth_configured",
"type": "boolean",
"_name_": "twofactor_auth_configured",
"_required_": true
},
{
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "sid",
"_name_": "sid",
"_required_": true
},
{
"items": [
{
"type": "string"
}
],
"title": "roles",
"type": "array",
"_name_": "roles",
"_required_": true
}
]
Sent on vm changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"command_line_args": {
"_name_": "command_line_args",
"title": "command_line_args",
"default": "",
"_required_": false,
"type": "string"
},
"cpu_mode": {
"_name_": "cpu_mode",
"title": "cpu_mode",
"default": "CUSTOM",
"_required_": false,
"type": "string",
"enum": [
"CUSTOM",
"HOST-MODEL",
"HOST-PASSTHROUGH"
]
},
"cpu_model": {
"_name_": "cpu_model",
"title": "cpu_model",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"name": {
"_name_": "name",
"title": "name",
"_required_": true,
"type": "string"
},
"description": {
"_name_": "description",
"title": "description",
"_required_": false,
"type": "string"
},
"vcpus": {
"type": "integer",
"_name_": "vcpus",
"title": "vcpus",
"default": 1,
"_required_": false
},
"cores": {
"type": "integer",
"_name_": "cores",
"title": "cores",
"default": 1,
"_required_": false
},
"threads": {
"type": "integer",
"_name_": "threads",
"title": "threads",
"default": 1,
"_required_": false
},
"cpuset": {
"_name_": "cpuset",
"title": "cpuset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"nodeset": {
"_name_": "nodeset",
"title": "nodeset",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"enable_cpu_topology_extension": {
"type": "boolean",
"_name_": "enable_cpu_topology_extension",
"title": "enable_cpu_topology_extension",
"default": false,
"_required_": false
},
"pin_vcpus": {
"type": "boolean",
"_name_": "pin_vcpus",
"title": "pin_vcpus",
"default": false,
"_required_": false
},
"suspend_on_snapshot": {
"type": "boolean",
"_name_": "suspend_on_snapshot",
"title": "suspend_on_snapshot",
"default": false,
"_required_": false
},
"trusted_platform_module": {
"type": "boolean",
"_name_": "trusted_platform_module",
"title": "trusted_platform_module",
"default": false,
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"_required_": true
},
"min_memory": {
"type": [
"integer",
"null"
],
"_name_": "min_memory",
"title": "min_memory",
"default": null,
"_required_": false
},
"hyperv_enlightenments": {
"type": "boolean",
"_name_": "hyperv_enlightenments",
"title": "hyperv_enlightenments",
"default": false,
"_required_": false
},
"bootloader": {
"_name_": "bootloader",
"title": "bootloader",
"default": "UEFI",
"_required_": false,
"type": "string",
"enum": [
"UEFI",
"UEFI_CSM"
]
},
"bootloader_ovmf": {
"_name_": "bootloader_ovmf",
"title": "bootloader_ovmf",
"default": "OVMF_CODE.fd",
"_required_": false,
"type": "string"
},
"autostart": {
"type": "boolean",
"_name_": "autostart",
"title": "autostart",
"default": true,
"_required_": false
},
"hide_from_msr": {
"type": "boolean",
"_name_": "hide_from_msr",
"title": "hide_from_msr",
"default": false,
"_required_": false
},
"ensure_display_device": {
"type": "boolean",
"_name_": "ensure_display_device",
"title": "ensure_display_device",
"default": true,
"_required_": false
},
"time": {
"_name_": "time",
"title": "time",
"default": "LOCAL",
"_required_": false,
"type": "string",
"enum": [
"LOCAL",
"UTC"
]
},
"shutdown_timeout": {
"type": "integer",
"_name_": "shutdown_timeout",
"title": "shutdown_timeout",
"default": 90,
"_required_": false
},
"arch_type": {
"_name_": "arch_type",
"title": "arch_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"machine_type": {
"_name_": "machine_type",
"title": "machine_type",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"uuid": {
"_name_": "uuid",
"title": "uuid",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"devices": {
"_name_": "devices",
"title": "devices",
"default": [],
"_required_": false,
"type": "array",
"items": []
},
"status": {
"type": "object",
"properties": {
"state": {
"_name_": "state",
"title": "state",
"_required_": true,
"type": "string"
},
"pid": {
"type": [
"integer",
"null"
],
"_name_": "pid",
"title": "pid",
"_required_": true
},
"domain_state": {
"_name_": "domain_state",
"title": "domain_state",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "status",
"title": "status",
"default": {},
"_required_": false,
"_attrs_order_": [
"state",
"pid",
"domain_state"
]
},
"display_available": {
"type": "boolean",
"_name_": "display_available",
"title": "display_available",
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_entry",
"title": "vm_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"command_line_args",
"cpu_mode",
"cpu_model",
"name",
"description",
"vcpus",
"cores",
"threads",
"cpuset",
"nodeset",
"enable_cpu_topology_extension",
"pin_vcpus",
"suspend_on_snapshot",
"trusted_platform_module",
"memory",
"min_memory",
"hyperv_enlightenments",
"bootloader",
"bootloader_ovmf",
"autostart",
"hide_from_msr",
"ensure_display_device",
"time",
"shutdown_timeout",
"arch_type",
"machine_type",
"uuid",
"devices",
"status",
"display_available",
"id"
]
}
]
Sent on vm.device changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"dtype": {
"_name_": "dtype",
"title": "dtype",
"_required_": true,
"type": "string",
"enum": [
"NIC",
"DISK",
"CDROM",
"PCI",
"DISPLAY",
"RAW",
"USB"
]
},
"vm": {
"type": "integer",
"_name_": "vm",
"title": "vm",
"_required_": true
},
"order": {
"type": [
"integer",
"null"
],
"_name_": "order",
"title": "order",
"default": null,
"_required_": false
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"attributes": {
"anyOf": [
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": false,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"create_zvol": {
"type": "boolean",
"_name_": "create_zvol",
"title": "create_zvol",
"_required_": false
},
"zvol_name": {
"_name_": "zvol_name",
"title": "zvol_name",
"_required_": false,
"type": "string"
},
"zvol_volsize": {
"type": "integer",
"_name_": "zvol_volsize",
"title": "zvol_volsize",
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"create_zvol",
"zvol_name",
"zvol_volsize",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"trust_guest_rx_filters": {
"type": "boolean",
"_name_": "trust_guest_rx_filters",
"title": "trust_guest_rx_filters",
"default": false,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "E1000",
"_required_": false,
"type": "string",
"enum": [
"E1000",
"VIRTIO"
]
},
"nic_attach": {
"_name_": "nic_attach",
"title": "nic_attach",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
},
"mac": {
"_name_": "mac",
"title": "mac",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"trust_guest_rx_filters",
"type",
"nic_attach",
"mac"
]
},
{
"type": "object",
"properties": {
"pptdev": {
"_name_": "pptdev",
"title": "pptdev",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"pptdev"
]
},
{
"type": "object",
"properties": {
"path": {
"_name_": "path",
"title": "path",
"_required_": true,
"type": "string"
},
"type": {
"_name_": "type",
"title": "type",
"default": "AHCI",
"_required_": false,
"type": "string",
"enum": [
"AHCI",
"VIRTIO"
]
},
"exists": {
"type": "boolean",
"_name_": "exists",
"title": "exists",
"_required_": false
},
"boot": {
"type": "boolean",
"_name_": "boot",
"title": "boot",
"default": false,
"_required_": false
},
"size": {
"type": [
"integer",
"null"
],
"_name_": "size",
"title": "size",
"default": null,
"_required_": false
},
"logical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "logical_sectorsize",
"title": "logical_sectorsize",
"default": null,
"_required_": false
},
"physical_sectorsize": {
"type": [
"integer",
"null"
],
"_name_": "physical_sectorsize",
"title": "physical_sectorsize",
"default": null,
"_required_": false
},
"iotype": {
"_name_": "iotype",
"title": "iotype",
"default": "THREADS",
"_required_": false,
"type": "string",
"enum": [
"NATIVE",
"THREADS",
"IO_URING"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"path",
"type",
"exists",
"boot",
"size",
"logical_sectorsize",
"physical_sectorsize",
"iotype"
]
},
{
"type": "object",
"properties": {
"resolution": {
"_name_": "resolution",
"title": "resolution",
"default": "1024x768",
"_required_": false,
"type": "string",
"enum": [
"1920x1200",
"1920x1080",
"1600x1200",
"1600x900",
"1400x1050",
"1280x1024",
"1280x720",
"1024x768",
"800x600",
"640x480"
]
},
"port": {
"type": [
"integer",
"null"
],
"_name_": "port",
"title": "port",
"default": null,
"_required_": false
},
"web_port": {
"type": [
"integer",
"null"
],
"_name_": "web_port",
"title": "web_port",
"default": null,
"_required_": false
},
"bind": {
"_name_": "bind",
"title": "bind",
"default": "127.0.0.1",
"_required_": false,
"type": "string"
},
"wait": {
"type": "boolean",
"_name_": "wait",
"title": "wait",
"default": false,
"_required_": false
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"web": {
"type": "boolean",
"_name_": "web",
"title": "web",
"default": true,
"_required_": false
},
"type": {
"_name_": "type",
"title": "type",
"default": "SPICE",
"_required_": false,
"type": "string",
"enum": [
"SPICE"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"resolution",
"port",
"web_port",
"bind",
"wait",
"password",
"web",
"type"
]
},
{
"type": "object",
"properties": {
"usb": {
"type": "object",
"properties": {
"vendor_id": {
"_name_": "vendor_id",
"title": "vendor_id",
"description": "Vendor id must start with \"0x\" prefix e.g 0x0451",
"_required_": true,
"type": "string"
},
"product_id": {
"_name_": "product_id",
"title": "product_id",
"description": "Product id must start with \"0x\" prefix e.g 0x16a8",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "usb",
"title": "usb",
"default": null,
"_required_": false,
"_attrs_order_": [
"vendor_id",
"product_id"
]
},
"controller_type": {
"_name_": "controller_type",
"title": "controller_type",
"default": "nec-xhci",
"_required_": false,
"type": "string",
"enum": [
"piix3-uhci",
"piix4-uhci",
"ehci",
"ich9-ehci1",
"vt82c686b-uhci",
"pci-ohci",
"nec-xhci",
"qemu-xhci"
]
},
"device": {
"_name_": "device",
"title": "device",
"default": null,
"_required_": false,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "attributes",
"title": "attributes",
"default": {},
"_required_": false,
"_attrs_order_": [
"usb",
"controller_type",
"device"
]
}
],
"nullable": false,
"_name_": "attributes",
"description": null,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "vm_device_entry",
"title": "vm_device_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"dtype",
"vm",
"order",
"id",
"attributes"
]
}
]
Sent on vmware changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"datastore": {
"_name_": "datastore",
"title": "datastore",
"_required_": true,
"type": "string"
},
"filesystem": {
"_name_": "filesystem",
"title": "filesystem",
"_required_": true,
"type": "string"
},
"hostname": {
"_name_": "hostname",
"title": "hostname",
"_required_": true,
"type": "string"
},
"password": {
"_name_": "password",
"title": "password",
"_required_": true,
"type": "string"
},
"username": {
"_name_": "username",
"title": "username",
"_required_": true,
"type": "string"
},
"id": {
"type": "integer",
"_name_": "id",
"title": "id",
"_required_": false
},
"state": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "state",
"title": "state",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "vmware_entry",
"title": "vmware_entry",
"default": {},
"_required_": false,
"_attrs_order_": [
"datastore",
"filesystem",
"hostname",
"password",
"username",
"id",
"state"
]
}
]
Sent on zfs.snapshot changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "zfs_snapshot_entry",
"title": "zfs_snapshot_entry",
"default": {},
"_required_": false,
"_attrs_order_": []
}
]
Notification of new and removed sessions.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "auth.sessions",
"title": "auth.sessions",
"_required_": false
}
]
Finished boot process
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "system.ready",
"title": "system.ready",
"_required_": false
}
]
Started reboot process
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "system.reboot",
"title": "system.reboot",
"_required_": false
}
]
Started shutdown process
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "system.shutdown",
"title": "system.shutdown",
"_required_": false
}
]
Sent on alert changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "alert.list",
"title": "alert.list",
"_required_": false
}
]
Sent on network configuration changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "network.config",
"title": "network.config",
"_required_": false
}
]
Sent when failover is being setup.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "failover.setup",
"title": "failover.setup",
"_required_": false
}
]
Sent when failover status changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "failover.status",
"title": "failover.status",
"_required_": false
}
]
Sent when system is ready and HA upgrade is pending.
It is expected the client will react by issuing upgrade_finish
call
at user will.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "failover.upgrade_pending",
"title": "failover.upgrade_pending",
"_required_": false
}
]
Sent on directory service state changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "directoryservices.status",
"title": "directoryservices.status",
"_required_": false
}
]
Docker state events
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "docker.state",
"title": "docker.state",
"_required_": false
}
]
Docker container events
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "docker.events",
"title": "docker.events",
"_required_": false
}
]
Sent on TrueCommand configuration changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "truecommand.config",
"title": "truecommand.config",
"_required_": false
}
]
Sent on disk changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "disk.query",
"title": "disk.query",
"_required_": false
}
]
Sent when failover status reasons change.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "failover.disabled.reasons",
"title": "failover.disabled.reasons",
"_required_": false
}
]
Sent when a VRRP state changes.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "failover.vrrp_event",
"title": "failover.vrrp_event",
"_required_": false
}
]
Progress of pool resilver/scrub.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "zfs.pool.scan",
"title": "zfs.pool.scan",
"_required_": false
}
]
Sent when root user login to the Web UI is disabled.
This event can be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "user.web_ui_login_disabled",
"title": "user.web_ui_login_disabled",
"_required_": false
}
]
Retrieve last no_of_lines
specified as an integer argument for a specific path
and then
any new lines as they are added. Specified argument has the format path:no_of_lines
( /var/log/messages:3
).
no_of_lines
is optional and if it is not specified it defaults to 3
.
However, path
is required for this.
This event cannot be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "filefollowtaileventsource",
"_required_": false
}
]
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "filefollowtaileventsource_returns",
"_required_": false
}
]
Reports current S.M.A.R.T. test progress for the specified disk.
This event cannot be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "smarttesteventsource",
"_required_": false
}
]
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "smarttesteventsource_returns",
"_required_": false
}
]
Retrieve currently running processes stats.
Usage: reporting.processes:{"interval": 10, "cpu_percent": 0.1, "memory_percent": 0.1}
This event cannot be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "processeseventsource",
"_required_": false
}
]
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "processeseventsource_returns",
"_required_": false
}
]
Retrieve real time statistics for CPU, network,
virtual memory and zfs arc.
This event cannot be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"interval": {
"type": "integer",
"_name_": "interval",
"title": "interval",
"default": 2,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "realtimeeventsource",
"default": {
"interval": 2
},
"_required_": false,
"_attrs_order_": [
"interval"
]
}
]
[
{
"type": "object",
"properties": {
"cpu": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "cpu",
"title": "cpu",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"disks": {
"type": "object",
"properties": {
"busy": {
"type": "float",
"_name_": "busy",
"title": "busy",
"_required_": false
},
"read_bytes": {
"type": "float",
"_name_": "read_bytes",
"title": "read_bytes",
"_required_": false
},
"write_bytes": {
"type": "float",
"_name_": "write_bytes",
"title": "write_bytes",
"_required_": false
},
"read_ops": {
"type": "float",
"_name_": "read_ops",
"title": "read_ops",
"_required_": false
},
"write_ops": {
"type": "float",
"_name_": "write_ops",
"title": "write_ops",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "disks",
"title": "disks",
"default": {},
"_required_": false,
"_attrs_order_": [
"busy",
"read_bytes",
"write_bytes",
"read_ops",
"write_ops"
]
},
"interfaces": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "interfaces",
"title": "interfaces",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"memory": {
"type": "object",
"properties": {
"classes": {
"type": "object",
"properties": {
"apps": {
"type": "integer",
"_name_": "apps",
"title": "apps",
"_required_": false
},
"arc": {
"type": "integer",
"_name_": "arc",
"title": "arc",
"_required_": false
},
"buffers": {
"type": "integer",
"_name_": "buffers",
"title": "buffers",
"_required_": false
},
"cache": {
"type": "integer",
"_name_": "cache",
"title": "cache",
"_required_": false
},
"page_tables": {
"type": "integer",
"_name_": "page_tables",
"title": "page_tables",
"_required_": false
},
"slab_cache": {
"type": "integer",
"_name_": "slab_cache",
"title": "slab_cache",
"_required_": false
},
"unused": {
"type": "integer",
"_name_": "unused",
"title": "unused",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "classes",
"title": "classes",
"default": {},
"_required_": false,
"_attrs_order_": [
"apps",
"arc",
"buffers",
"cache",
"page_tables",
"slab_cache",
"unused"
]
},
"extra": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "extra",
"title": "extra",
"default": {},
"_required_": false,
"_attrs_order_": []
}
},
"additionalProperties": false,
"_name_": "memory",
"title": "memory",
"default": {},
"_required_": false,
"_attrs_order_": [
"classes",
"extra"
]
},
"virtual_memory": {
"type": "object",
"properties": {},
"additionalProperties": true,
"_name_": "virtual_memory",
"title": "virtual_memory",
"default": {},
"_required_": false,
"_attrs_order_": []
},
"zfs": {
"type": "object",
"properties": {
"arc_max_size": {
"type": "integer",
"_name_": "arc_max_size",
"title": "arc_max_size",
"_required_": false
},
"arc_size": {
"type": "integer",
"_name_": "arc_size",
"title": "arc_size",
"_required_": false
},
"cache_hit_ratio": {
"type": "float",
"_name_": "cache_hit_ratio",
"title": "cache_hit_ratio",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "zfs",
"title": "zfs",
"default": {},
"_required_": false,
"_attrs_order_": [
"arc_max_size",
"arc_size",
"cache_hit_ratio"
]
}
},
"additionalProperties": false,
"_name_": "realtimeeventsource_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"cpu",
"disks",
"interfaces",
"memory",
"virtual_memory",
"zfs"
]
}
]
Notifies of current system health which include statistics about consumption of memory and CPU, pools and
if updates are available. An integer delay
argument can be specified to determine the delay
on when the periodic event should be generated.
This event cannot be subscribed to with the wildcard *
as the event name.
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "systemhealtheventsource",
"_required_": false
}
]
[
{
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
},
{
"type": "object"
},
{
"type": "array"
}
],
"nullable": true,
"_name_": "systemhealtheventsource_returns",
"_required_": false
}
]
Retrieve statistics of apps.
This event cannot be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"interval": {
"type": "integer",
"_name_": "interval",
"title": "interval",
"default": 2,
"_required_": false
}
},
"additionalProperties": false,
"_name_": "appstatseventsource",
"default": {
"interval": 2
},
"_required_": false,
"_attrs_order_": [
"interval"
]
}
]
[
{
"_name_": "apps_stats",
"title": "apps_stats",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"app_name": {
"_name_": "app_name",
"title": "app_name",
"_required_": false,
"type": "string"
},
"cpu_usage": {
"type": "integer",
"_name_": "cpu_usage",
"title": "cpu_usage",
"description": "Percentage of cpu used by an app",
"_required_": false
},
"memory": {
"type": "integer",
"_name_": "memory",
"title": "memory",
"description": "Current memory(in bytes) used by an app",
"_required_": false
},
"networks": {
"_name_": "networks",
"title": "networks",
"default": [],
"_required_": false,
"type": "array",
"items": [
{
"type": "object",
"properties": {
"interface_name": {
"_name_": "interface_name",
"title": "interface_name",
"description": "Name of the interface use by the app",
"_required_": false,
"type": "string"
},
"rx_bytes": {
"type": "integer",
"_name_": "rx_bytes",
"title": "rx_bytes",
"description": "Received bytes/s by an interface",
"_required_": false
},
"tx_bytes": {
"type": "integer",
"_name_": "tx_bytes",
"title": "tx_bytes",
"description": "Transmitted bytes/s by an interface",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "interface_stats",
"title": "interface_stats",
"default": {},
"_required_": false,
"_attrs_order_": [
"interface_name",
"rx_bytes",
"tx_bytes"
]
}
]
},
"blkio": {
"type": "object",
"properties": {
"read": {
"type": "integer",
"_name_": "read",
"title": "read",
"description": "Blkio read bytes",
"_required_": false
},
"write": {
"type": "integer",
"_name_": "write",
"title": "write",
"description": "Blkio write bytes",
"_required_": false
}
},
"additionalProperties": false,
"_name_": "blkio",
"title": "blkio",
"default": {},
"_required_": false,
"_attrs_order_": [
"read",
"write"
]
}
},
"additionalProperties": false,
"_name_": "stats",
"title": "stats",
"default": {},
"_required_": false,
"_attrs_order_": [
"app_name",
"cpu_usage",
"memory",
"networks",
"blkio"
]
}
]
}
]
Retrieve logs of a container/service in an app.
Name of app and id of container/service is required.
Optionally tail_lines
and limit_bytes
can be specified.
tail_lines
is an option to select how many lines of logs to retrieve for the said container. It
defaults to 500. If set to null
, it will retrieve complete logs of the container.
This event cannot be subscribed to with the wildcard *
as the event name.
[
{
"type": "object",
"properties": {
"tail_lines": {
"type": [
"integer",
"null"
],
"_name_": "tail_lines",
"title": "tail_lines",
"default": 500,
"_required_": false,
"description": "Optionally `tail_lines` and `limit_bytes` can be specified."
},
"app_name": {
"_name_": "app_name",
"title": "app_name",
"_required_": true,
"type": "string"
},
"container_id": {
"_name_": "container_id",
"title": "container_id",
"_required_": true,
"type": "string"
}
},
"additionalProperties": false,
"_name_": "appcontainerlogsfollowtaileventsource",
"default": {},
"_required_": false,
"_attrs_order_": [
"tail_lines",
"app_name",
"container_id"
]
}
]
[
{
"type": "object",
"properties": {
"data": {
"_name_": "data",
"title": "data",
"_required_": true,
"type": "string"
},
"timestamp": {
"_name_": "timestamp",
"title": "timestamp",
"_required_": true,
"type": [
"string",
"null"
]
}
},
"additionalProperties": false,
"_name_": "appcontainerlogsfollowtaileventsource_returns",
"default": {},
"_required_": false,
"_attrs_order_": [
"data",
"timestamp"
]
}
]
Events are generated by the system based on when certain conditions are met. It is not useful
if the system is generating an event and there is no event listener. Listening to events
is called subscribing
.
A client can subscribe to all system events by specifying *
. This only applies to events
that accept *
as a wildcard (refer to the list above for events that accept *
).
Request:
{
"id": "ad4dea8f-53a8-9a5c-1825-523e218c13ca",
"name": "*",
"msg": "sub"
}
Response:
{
"msg": "ready",
"subs": ["ad4dea8f-53a8-9a5c-1825-523e218c13ca"]
}
The example above subscribes the websocket client to system events that accept *
as a wildcard.
Each time an event is generated by the system the websocket client would get the event.
Event Response Example:
{
"msg": "changed",
"collection": "core.get_jobs",
"id": 79,
"fields": {
"id": 79, "method": "pool.scrub.scrub",
"arguments": ["vol1", "START"], "logs_path": null,
"logs_excerpt": null,
"progress": {"percent": 0.001258680822502356, "description": "Scrubbing", "extra": null},
"result": null, "error": null, "exception": null, "exc_info": null,
"state": "RUNNING", "time_started": {"$date": 1571297741181},
"time_finished": null
}
}
The event above was generated by the system when a pool is scrubbed.
The example below is how to subscribe to the reporting.realtime
event.
Request:
{
"id": "8592f7c2-ce2b-4466-443a-80bbae5937d9",
"name": "reporting.realtime",
"msg": "sub"
}
Response:
{
"msg": "ready",
"subs": ["8592f7c2-ce2b-4466-443a-80bbae5937d9"]
}
Event Response Example:
{
"msg": "added", "collection": "reporting.realtime",
"fields": {
"virtual_memory": {
"total": 4784615424, "available": 854155264, "percent": 82.1,
"used": 3779424256, "free": 136634368, "active": 894599168,
"inactive": 717520896, "buffers": 0, "cached": 0,
"shared": 188002304, "wired": 2884825088
},
"cpu": {"temperature": {}},
"interfaces": {
"em0": {
"received_bytes": 1068597254, "received_bytes_last": 1068597254,
"sent_bytes": 78087857, "sent_bytes_last": 78087857
},
"lo0": {
"received_bytes": 358364554, "received_bytes_last": 358364554,
"sent_bytes": 358360787, "sent_bytes_last": 358360787
}
}
}
}
The example below is how to subscribe to jobs.
Request:
{
"id": "19922f7c2-ce2b-4455-443a-80bbae5937a2",
"name": "core.get_jobs",
"msg": "sub"
}
Response:
{
"msg": "ready",
"subs": ["19922f7c2-ce2b-4455-443a-80bbae5937a2"]
}
Event Response Example:
{
"msg": "added", "collection": "core.get_jobs", "id": 26,
"fields": {
"id": 26, "method": "failover.reboot.other_node", "arguments": [],
"logs_path": null, "logs_excerpt": null,
"progress": {"percent": null, "description": null, "extra": null},
"result": null, "error": null, "exception": null, "exc_info": null,
"state": "WAITING", "time_started": {"$date": 1571305262662},
"time_finished": null
}
}
The event above was generated when a reboot for other HA node was started. The event response shows that system has registered the job and the job is waiting to be executed.
After the client has consumed the information required and no more updates are required, an event can be unsubscribed as shown here:
Request:
{
"id": "8592f7c2-ce2b-4466-443a-80bbae5937d9",
"msg": "unsub"
}
The server does not send a response for this call. This example unsubscribes
from the reporting.realtime
event that was subscribed to above. The id
is the same value
sent when subscribing to the event.
Tasks which require significant time to execute or process a significant amount of input or output are tagged as jobs. When a client connects to an endpoint marked as a job, they receive a job id from the endpoint. With this job id, the client can query the status of the job to see the progress and status. Errors are shown in the output, or the output contains the result returned by the endpoint on completion.
e.g. ws://truenas.domain/websocket
connect
message.{
"id": "6841f242-840a-11e6-a437-00e04d680384",
"msg": "method",
"method": "catalog.sync_all",
"params": []
}
job_id
.{
"msg": "result",
"id": "c0bb5952-fc60-232a-3d6c-a47961b771a5",
"result": 53
}
Job status can be queried with the core.get_jobs
method.
Request:
{
"id": "d8e715be-6bc7-11e6-8c28-00e04d680384",
"msg": "method",
"method": "core.get_jobs",
"params": [[["id", "=", 53]]]
}
Response:
{
"id": "d8e715be-6bc7-11e6-8c28-00e04d680384",
"msg": "result",
"result": [{"id": 53, "method": "catalog.sync_all", "arguments": [], "logs_path": null, "logs_excerpt": null, "progress": {"percent": 100, "description": "Syncing TEST catalog", "extra": null}, "result": null, "error": null, "exception": null, "exc_info": null, "state": "SUCCESS", "time_started": {"$date": 1571300596053}, "time_finished": null}]
}
There are some jobs which require input or output as files which can be uploaded or downloaded.
If a job gives a file as an output, this endpoint is to be used to download the output file.
Request:
{
"id": "d8e715be-6bc7-11e6-8c28-00e04d680384",
"msg": "method",
"method": "core.download",
"params": ["config.save", [{}], "freenas-FreeNAS-11.3-MASTER-201910090828-20191017122016.db"]
}
Response:
{
"id": "cdc8740a-336b-b0cd-b850-47568fe94223",
"msg": "result",
"result": [86, "/_download/86?auth_token=9WIqYg4jAYEOGQ4g319Bkr64Oj8CZk1VACfyN68M7hgjGTdeSSgZjSf5lJEshS8M"]
}
In the response, the first value 86
is the job id for config.save
. This can be used to query
the status of the job. The second value is a REST endpoint used to download the file.
The download endpoint has a special format:
http://system_ip/_download/{job_id}?auth_token={token}
job_id
and token
are parameters being passed.
core.download
takes responsibility for providing the download URI with the job_id
and token
values.
Note: 1) Job output is not buffered, so execution would be blocked if a file download is not started. 2) File download must begin within 60 seconds or the job is canceled. 3) The file can only be downloaded once.
Files can be uploaded via HTTP POST request only. The upload endpoint is:
http://system_ip/_upload
It expects two values as form data, data
and file
.
data
is JSON-encoded data. It must be the first parameter provided and in this format:
::: json
{
"method": "config.upload",
"params": []
}
file
is the URI of the file to download.
This example uses curl
,
Request:
curl -X POST -u root:freenas -H "Content-Type: multipart/form-data" -F 'data={"method": "config.upload", "params": []}' -F "file=@/home/user/Desktop/config" http://system_ip/_upload/
Response:
{"job_id": 20}
TrueNAS API has multiple query methods including pool.query
, disk.query
, vm.query
, and many more.
The arguments for these methods support multiple options and filters that are similar to SQL queries.
Query Filters are primarily an array of conditions, with each condition also represented as an array.
Each condition in the filter list should compare a field with a value.
eg. Filter Syntax: ["field", "operator", value]
For example, to filter the data returned by disk.query
, we provide a list of conditions:
Javascript:
[
["name","=","ada1"]
]
Operator | Description |
---|---|
'=' | x == y |
'!=' | x != y |
'>' | x > y |
'>=' | x >= y |
'<' | x < y |
'<=' | x <= y |
'~' | re.match(y, x) |
'in' | x in y |
'nin' | x not in y |
'rin' | x is not None and y in x |
'rnin' | x is not None and y not in x |
'^' | x is not None and x.startswith(y) |
'!^' | x is not None and not x.startswith(y) |
'$' | x is not None and x.endswith(y) |
'!$' | x is not None and not x.endswith(y) |
Specifing the prefix 'C' will perform a case-insensitive version of the filter, e.g. C=
.
We can use disk.query
with the "type" and "rotationrate" filters to find hard drives with a rotation rate higher than 5400 RPM:
Javascript:
[
["type","=","HDD"],
["rotationrate",">",5400] // Note that the value should be the correct type
]
Queries with no explicitly defined logical connectives assume conjunction AND
. The disjunction OR
is also supported by using the syntax illustrated below. We can use disk.query
with OR
to filter disks by name. Note that the operand for the disjunction contains an array of conditions.
The following is a valid example. Javascript:
["OR",
[
["name","=", "first"],
["name","=", "second"],
]
]
The following is also a valid example that returns users that are unlocked and either have password-based authentication for SSH enabled or are SMB users. Javascript:
[
["OR",
[
["ssh_password_enabled", "=", true],
["smb", "=", true]
]
],
["locked", "=", false]
]
The following is valid example that returns users who are either enabled or have password authentication enabled with two-factor authentication disabled.
Javascript:
["OR",
[
[["ssh_password_enabled", "=", true], ["twofactor_auth_configured", "=", false]],
["enabled","=", true],
]
]
Some additional examples of connective use are as follows.
These filters when used with user.query
finds unlocked users with password authentication enabled and two-factor authentication disabled.
Javascript:
[
["ssh_password_enabled", "=", true],
["twofactor_auth_configured", "=", false],
["locked", "=", false]
]
Sub-keys in complex JSON objects may be specified by using dot (".") to indicate the key. For example the following query-filters if passed to user.query
endpoint will return entries with a primary group ID of 3000.
Javascript:
[
["group.bsdgrp_gid", "=", 3000],
]
If a key contains a literal dot (".") in its name, then it must be escaped via a double backslash.
Javascript:
[
["foo\\.bar", "=", 42],
]
When the path to the key contains an array, an array index may be manually specified. For example, the following query-filters
if passed to the privilege.query
endpoint will return entries where the first element of the local groups array has a name
of "myuser".
Javascript:
[
["local_groups.0.name", "=", "myuser"],
]
Alternatively, an asterisk (*
) may be substituted for the array index, which match any entry where an array member has a key matching the value. for example, the following query-filters if passed to the privilege.query
endpoint will return entries where any member of the local groups array has a name
key with the value of myuser
.
Javascript:
[
["local_groups.*.name", "=", "myuser"],
]
Some query results may include datetime information encoded in JSON object via
key with designator .$date
. In this case, query filter using an ISO-8601
timestamp may be used. For example:
Javascript:
[
['timestamp.$date', '>', '2023-12-18T16:15:35+00:00']
]
Query Options are objects that can further customize the results returned by a Query Method.
Properties of a Query Option include extend | extend_context | prefix | extra | order_by | select | count | get | limit | offset
Use the count
option to get the number of results returned.
Javascript:
{
"count": true
}
Use the limit
option to limit the number of results returned.
Javascript:
{
"limit": 5
}
Use the offset
option to remove the first items from a returned list.
Javascript:
{
"offset": 1 // Omits the first item from the query result
}
Use the select
option to specify the exact fields to return. Fields must be provided in an array of strings. The dot character (".") may be used to explicitly select only subkeys of the query result.
Fields returned may be renamed by specifing an array containing two strings with the first string being the field to select from results list and the second string indicating the new name to provide it.
Javascript:
{
"select": ["devname","size","rotationrate"]
}
Javascript:
{
"select": [
"Authentication.status",
"Authentication.localAddress",
"Authentication.clientAccount"
]
}
Javascript:
{
"select": [
["Authentication.status", "status"],
["Authentication.localAddress", "address"],
["Authentication.clientAccount", "username"]
]
}
Use the order_by
option to specify which field determines the sort order. Fields must be provided in an
array of strings.
The following prefixes may be applied to the field name:
-
reverse sort direction.
nulls_first:
place any NULL values at head of results list.
nulls_last:
place any NULL values at tail of results list.
Javascript:
{
"order_by": ["size", "-devname", "nulls_first:-expiretime"]
}
NOTE: these are examples of syntax translation, they are not intended as queries to perform on the TrueNAS server.
query-filters
Javascript:
[]
query-options
Javascript:
{}
query-filters
Javascript:
[
["builtin", "=", false],
]
query-options
Javascript:
{
"select": [
"username",
"uid"
],
"order_by": [
"-uid"
]
}
query-filters
Javascript:
[
["builtin", "=", false],
["locked", "=", true]
]
query-options
Javascript:
{
"select": [
[
"username",
"locked_user"
],
"uid"
],
}
query-filters
Javascript:
[
["OR",
[
["builtin", "=", false],
[["locked", "=", false], ["ssh", "=" true]]
]
],
]
query-options
Javascript:
{
"select": [
"username"
],
}