NSX Autonomous Edge REST API
ActionDescriptor (type)
{
"additionalProperties": false,
"id": "ActionDescriptor",
"properties": {
"description": {
"readonly": true,
"title": "A description of what the action does",
"type": "string"
},
"descriptor": {
"readonly": true,
"required": true,
"title": "The URI of the REST routine provider that implements the action",
"type": "string"
},
"name": {
"readonly": true,
"required": true,
"title": "The name of the action",
"type": "string"
},
"uri": {
"readonly": true,
"required": true,
"title": "The URI to use to invoke the action",
"type": "string"
}
},
"type": "object"
}
ApiCertificate (type)
{
"additionalProperties": false,
"id": "ApiCertificate",
"properties": {
"api_certificate": {
"description": "API certificate",
"required": true,
"type": "string"
},
"api_key": {
"description": "API private key",
"required": false,
"sensitive": true,
"type": "string"
},
"ca_certificate": {
"description": "CA certificate",
"required": true,
"type": "string"
}
},
"type": "object"
}
ApiCertificateReply (type)
{
"id": "ApiCertificateReply",
"properties": {
"status": {
"description": "API certificate replacement status",
"required": true,
"type": "string"
}
},
"type": "object"
}
ApplianceManagementSuppressRedirectQueryParameter (type)
{
"additionalProperties": false,
"id": "ApplianceManagementSuppressRedirectQueryParameter",
"properties": {
"suppress_redirect": {
"default": false,
"description": "Do not return a redirect HTTP status.",
"title": "Suppress redirect status if applicable",
"type": "boolean"
}
},
"type": "object"
}
ApplianceManagementTaskListResult (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListResult
},
"id": "ApplianceManagementTaskListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "ApplianceManagementTaskProperties
},
"required": true,
"title": "Task property results",
"type": "array"
}
},
"title": "Appliance management task query results",
"type": "object"
}
ApplianceManagementTaskProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "ApplianceManagementTaskProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"async_response_available": {
"readonly": true,
"title": "True if response for asynchronous request is available",
"type": "boolean"
},
"cancelable": {
"readonly": true,
"title": "True if this task can be canceled",
"type": "boolean"
},
"description": {
"readonly": true,
"title": "Description of the task",
"type": "string"
},
"details": {
"readonly": true,
"title": "Details about the task if known",
"type": "object"
},
"end_time": {
"$ref": "EpochMsTimestamp,
"readonly": true,
"title": "The end time of the task in epoch milliseconds"
},
"id": {
"pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}_[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$",
"readonly": true,
"title": "Identifier for this task",
"type": "string"
},
"message": {
"readonly": true,
"title": "A message describing the disposition of the task",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"progress": {
"maximum": 100,
"minimum": 0,
"readonly": true,
"title": "Task progress if known, from 0 to 100",
"type": "integer"
},
"request_is_async": {
"readonly": true,
"title": "True if request was invoked with Vmw-Async:true header; otherwise, false",
"type": "boolean"
},
"request_method": {
"readonly": true,
"title": "HTTP request method",
"type": "string"
},
"request_uri": {
"readonly": true,
"title": "URI of the method invocation that spawned this task",
"type": "string"
},
"start_time": {
"$ref": "EpochMsTimestamp,
"readonly": true,
"title": "The start time of the task in epoch milliseconds"
},
"status": {
"$ref": "ApplianceManagementTaskStatus,
"readonly": true,
"title": "Current status of the task"
},
"user": {
"readonly": true,
"title": "Name of the user who created this task",
"type": "string"
}
},
"title": "Appliance management task properties",
"type": "object"
}
ApplianceManagementTaskQueryParameters (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListResultQueryParameters
},
"id": "ApplianceManagementTaskQueryParameters",
"properties": {
"fields": {
"description": "Comma-separated field names to include in query result",
"title": "Fields to include in query results",
"type": "string"
},
"request_method": {
"description": "Comma-separated request methods to include in query result",
"pattern": "^(=|!=|~|!~)?.+$",
"title": "Request method(s) to include in query result",
"type": "string"
},
"request_path": {
"description": "Comma-separated request paths to include in query result",
"pattern": "^(=|!=|~|!~)?.+$",
"title": "Request URI path(s) to include in query result",
"type": "string"
},
"request_uri": {
"description": "Comma-separated request URIs to include in query result",
"pattern": "^(=|!=|~|!~)?.+$",
"title": "Request URI(s) to include in query result",
"type": "string"
},
"status": {
"description": "Comma-separated status values to include in query result",
"pattern": "^(=|!=|~|!~)?.+$",
"title": "Status(es) to include in query result",
"type": "string"
},
"user": {
"description": "Comma-separated user names to include in query result",
"pattern": "^(=|!=|~|!~)?.+$",
"title": "Names of users to include in query result",
"type": "string"
}
},
"type": "object"
}
ApplianceManagementTaskStatus (type)
{
"enum": [
"running",
"error",
"success",
"canceling",
"canceled",
"killed"
],
"id": "ApplianceManagementTaskStatus",
"title": "Current status of the appliance management task",
"type": "string"
}
AuthenticationPolicyProperties (type)
{
"additionalProperties": {},
"extends": {
"$ref": "PasswordComplexityProperties
},
"id": "AuthenticationPolicyProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_retry_prompt": {
"default": 3,
"readonly": true,
"title": "Prompt user at most N times before returning with error.",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"api_failed_auth_lockout_period": {
"default": 900,
"description": "Once a lockout occurs, the account remains locked out of the API for this time period. Only applies to NSX Manager nodes. Ignored on other node types.",
"maximum": 9000,
"minimum": 0,
"title": "Lockout period in seconds",
"type": "integer"
},
"api_failed_auth_reset_period": {
"default": 900,
"description": "In order to trigger an account lockout, all authentication failures must occur in this time window. If the reset period expires, the failed login count is reset to zero. Only applies to NSX Manager nodes. Ignored on other node types.",
"maximum": 9000,
"minimum": 0,
"title": "Period, in seconds, for authentication failures to trigger lockout",
"type": "integer"
},
"api_max_auth_failures": {
"default": 5,
"description": "Only applies to NSX Manager nodes. Ignored on other node types.",
"maximum": 50,
"minimum": 0,
"title": "Number of authentication failures that trigger API lockout",
"type": "integer"
},
"cli_failed_auth_lockout_period": {
"default": 900,
"description": "Once a lockout occurs, the account remains locked out of the CLI for this time period. While the lockout period is in effect, additional authentication attempts restart the lockout period, even if a valid password is specified.",
"maximum": 604800,
"minimum": 0,
"title": "Lockout period in seconds",
"type": "integer"
},
"cli_max_auth_failures": {
"default": 5,
"maximum": 10,
"minimum": 0,
"title": "Number of authentication failures that trigger CLI lockout",
"type": "integer"
},
"digits": {
"default": -1,
"description": "Number of digits (0..9) expected in user password. <p>N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.</p> <p>N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> digits.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 digit is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of digits in password",
"type": "integer"
},
"hash_algorithm": {
"default": "sha512",
"description": "Sets hash/cryptographic algorithm type for new passwords.",
"enum": [
"sha512",
"sha256"
],
"title": "Hash algorithm",
"type": "string"
},
"lower_chars": {
"default": -1,
"description": "Number of lower case characters (a..z) expected in user password. <p>N < 0, to set minimum credit for having lower case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having lower case characters in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> lower case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 lower case character is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of lower-case characters in password",
"type": "integer"
},
"max_repeats": {
"default": 0,
"description": "Reject passwords which contain more than N same consecutive characters, like aaa or 7777. To disable the check, value should be set to 0.",
"maximum": 128,
"minimum": 0,
"title": "Number of same consecutive characters",
"type": "integer"
},
"max_sequence": {
"default": 0,
"description": "Reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0.",
"maximum": 128,
"minimum": 0,
"title": "Length of permissible monotonic sequence in password substring",
"type": "integer"
},
"maximum_password_length": {
"default": 128,
"description": "Maximum number of characters allowed in password; user can not set their password of length greater than this parameter. By default maximum length of password is 128 characters.",
"maximum": 128,
"minimum": 8,
"title": "Maximum password length",
"type": "integer"
},
"minimum_password_length": {
"default": 12,
"description": "Minimum number of characters expected in password; user can not set their password of length less than this parameter.<br /> NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above - <p>if existing appliance is configured with <code>minimum_password_length</code> less than current default value, then upgraded appliance will reset the configured setting back to recommended default; which can be explicitly modified back to original value or any other integer greater than or equal to supported minimum value.</p> <p>VMware recommends to set strong passwords for systems and appliances, further suggests to maintain strong <code>minimum_password_length</code> value. NSX resets this value to default and recommends to maintain upgraded default value or above for password complexity requirement.</p> <p>If any existing user passwords are set with length of less than newly configured <code>minimum_password_length</code>, then its recommended to reset the user passwords as per newly configured password complexity compliance.</p> <p>If existing <code>minimum_password_length</code> is greater than or equal to default value, which shall be retained as it is in newly upgraded appliance.</p> By default minimum length of password is 12 characters and passwords less than 8 characters are never allowed.",
"maximum": 128,
"minimum": 8,
"title": "Minimum password length",
"type": "integer"
},
"minimum_unique_chars": {
"default": 0,
"description": "Number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0.",
"maximum": 128,
"minimum": 0,
"title": "Number of unique characters from old password",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"password_remembrance": {
"default": 0,
"description": "Limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0.",
"minimum": 0,
"title": "Password remembrance from previous generations",
"type": "integer"
},
"special_chars": {
"default": -1,
"description": "Number of special characters (!@#$&*..) expected in user password. <p>N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> special case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 special character is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of special characters in password",
"type": "integer"
},
"upper_chars": {
"default": -1,
"description": "Number of upper case characters (A..Z) expected in user password. <p>N < 0, to set minimum credit for having upper case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> upper case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 upper case character is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of upper-case characters in password",
"type": "integer"
}
},
"title": "Configuration of authentication and password policies for the NSX node",
"type": "object"
}
AuthenticationScheme (type)
{
"additionalProperties": {},
"id": "AuthenticationScheme",
"properties": {
"scheme_name": {
"required": true,
"title": "Authentication scheme name",
"type": "string"
}
},
"type": "object"
}
AutonomousEdgeClusterConfig (type)
{
"id": "AutonomousEdgeClusterConfig",
"properties": {
"nodes": {
"items": {
"$ref": "TransportNodeInEdgeCluster
},
"maxItems": 2,
"minItems": 1,
"title": "Nodes in the cluster",
"type": "array"
}
},
"type": "object"
}
BasicAuthenticationScheme (type)
{
"additionalProperties": false,
"extends": {
"$ref": "AuthenticationScheme
},
"id": "BasicAuthenticationScheme",
"properties": {
"password": {
"required": true,
"sensitive": true,
"title": "Password to authenticate with",
"type": "string"
},
"scheme_name": {
"enum": [
"basic"
],
"required": true,
"title": "Authentication scheme name",
"type": "string"
},
"username": {
"pattern": "^.+$",
"required": true,
"title": "User name to authenticate with",
"type": "string"
}
},
"type": "object"
}
BlackholeAction (type)
{
"additionalProperties": false,
"enum": [
"DISCARD"
],
"id": "BlackholeAction",
"title": "Action to be taken on matching packets for NULL routes. For action is DISCARD, matching packets are dropped rather than forwarded.",
"type": "string"
}
Certificate (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ManagedResource
},
"id": "Certificate",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"details": {
"description": "list of X509Certificates",
"items": {
"$ref": "X509Certificate
},
"readonly": true,
"required": false,
"type": "array"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"pem_encoded": {
"description": "pem encoded certificate data",
"readonly": false,
"required": true,
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"used_by": {
"description": "list of node IDs with services, that are using this certificate",
"items": {
"$ref": "NodeIdServicesMap
},
"readonly": true,
"required": false,
"type": "array"
}
},
"type": "object"
}
CertificateList (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListResult
},
"id": "CertificateList",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"description": "Certificate list",
"items": {
"$ref": "Certificate
},
"readonly": true,
"required": true,
"type": "array"
}
},
"title": "Certificate queries result",
"type": "object"
}
ConfigType (type)
{
"enum": [
"nsxa-state",
"nsxa-edge-cluster",
"nsxa-lrouter",
"nsxa-service-router",
"nestdb",
"edge-agent",
"dataplane",
"nsd",
"manager",
"controller",
"core"
],
"id": "ConfigType",
"title": "Config Type",
"type": "string"
}
CopyFromRemoteFileProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "CopyRemoteFileProperties
},
"id": "CopyFromRemoteFileProperties",
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Server port",
"type": "integer"
},
"preserve_file_properties": {
"default": true,
"required": false,
"title": "Preserve file properties flag",
"type": "boolean"
},
"protocol": {
"$ref": "Protocol,
"required": true,
"title": "Protocol to use to copy file"
},
"server": {
"pattern": "^.+$",
"required": true,
"title": "Remote server hostname or IP address",
"type": "string"
},
"uri": {
"required": true,
"title": "URI of file to copy",
"type": "string"
}
},
"type": "object"
}
CopyRemoteFileProperties (type)
{
"additionalProperties": {},
"id": "CopyRemoteFileProperties",
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Server port",
"type": "integer"
},
"preserve_file_properties": {
"default": true,
"required": false,
"title": "Preserve file properties flag",
"type": "boolean"
},
"server": {
"pattern": "^.+$",
"required": true,
"title": "Remote server hostname or IP address",
"type": "string"
},
"uri": {
"required": true,
"title": "URI of file to copy",
"type": "string"
}
},
"type": "object"
}
CopyToRemoteFileProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "CopyRemoteFileProperties
},
"id": "CopyToRemoteFileProperties",
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Server port",
"type": "integer"
},
"preserve_file_properties": {
"default": true,
"required": false,
"title": "Preserve file properties flag",
"type": "boolean"
},
"protocol": {
"$ref": "Protocol,
"description": "Only scp and sftp may be used.",
"required": true,
"title": "Protocol to use to copy file"
},
"server": {
"pattern": "^.+$",
"required": true,
"title": "Remote server hostname or IP address",
"type": "string"
},
"uri": {
"required": true,
"title": "URI of file to copy",
"type": "string"
}
},
"type": "object"
}
CoreDumpConfig (type)
{
"additionalProperties": false,
"description": "Node core dump config",
"id": "CoreDumpConfig",
"properties": {
"global_file_limit": {
"default": 2,
"minimum": 0,
"title": "Core dump file persistence config global limit",
"type": "integer"
},
"global_frequency_threshold": {
"default": 600,
"minimum": 0,
"title": "Core dump files frequency threshold config in seconds, set 0 to disable\n",
"type": "integer"
},
"process_config": {
"items": {
"$ref": "CoreDumpProcessConfig
},
"title": "Core dump config per process limit",
"type": "array"
}
},
"title": "Node core dump config",
"type": "object"
}
CoreDumpProcessConfig (type)
{
"id": "CoreDumpProcessConfig",
"properties": {
"limit": {
"required": true,
"title": "Core dump process limit",
"type": "integer"
},
"process_name": {
"required": true,
"title": "Core dump process name",
"type": "string"
}
},
"title": "Core dump process config",
"type": "object"
}
CpuStats (type)
{
"additionalProperties": false,
"description": "Provides the following CPU stats for a given core: - Core ID. - CPU type. - Number of packets sent and received per second on the core for the last 100ms. - Number of packets received per second from the crypto module, the KNI interface, the slowpath threads and the other cores within the last 100ms. - Statistics of the mega flow cache which holds flow cache key and the corresponding flow cache actions for all the entries. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart. - Statistics of the micro flow cache which holds a hash of the entire flow cache key and a pointer to the mega flow cache entry. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart. - Percentage of live CPU utilization of the core sampled within the last 60 seconds. - Percentage of CPU utilization of the core for actual packet processing for the last 100ms.",
"id": "CpuStats",
"properties": {
"core": {
"description": "CPU id",
"readonly": true,
"title": "core id",
"type": "string"
},
"cpu_type": {
"default": "controlpath_core",
"description": "cpu type, one of datapath_core, controlpath_core and service_core",
"enum": [
"datapath_core",
"controlpath_core",
"service_core"
],
"readonly": true,
"title": "cpu type",
"type": "string"
},
"crypto": {
"description": "The total number of packets per second (pps) received from the crypto module for the last 100ms.",
"readonly": true,
"title": "CPU crypto packet rate",
"type": "string"
},
"intercore": {
"description": "The total number of packets per second (pps) received from other cores for the last 100ms.",
"readonly": true,
"title": "CPU intercore packet rate",
"type": "string"
},
"kni": {
"description": "The total number of packets per second (pps) received from Linux KNI interface for the last 100ms.",
"readonly": true,
"title": "CPU Kernel Network Interface (KNI) packet rate",
"type": "string"
},
"mega_flowcachestats": {
"$ref": "FlowCacheStatistics,
"description": "Provides statistics of the mega flow cache which holds the flow cache key and the corresponding flow cache actions for all the entries. The flow cache key is the five tuples of an IP connection - src/dst IP, protocol, and src/dst ports. This will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Mega flow cache stats",
"type": "object"
},
"micro_flowcachestats": {
"$ref": "FlowCacheStatistics,
"description": "Provides statistics of the micro flow cache which holds a hash of the entire flow cache key and a pointer to the mega flow cache entry, where the flow cache key and actions are stored. This will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Micro flow cache stats",
"type": "object"
},
"packet_processing_usage": {
"description": "Provides the percentage of CPU utilization of the core on actual packet processing for the last 100ms. It is percentage of busy cycles vs. total cycles, where busy cycles are the cycles spent in a poll round where at least one packet was received.",
"readonly": true,
"title": "Datapath CPU packet processing usage",
"type": "string"
},
"rx": {
"description": "The total number of packets per second (pps) received from NICs for the last 100ms.",
"readonly": true,
"title": "CPU Rx packet rate",
"type": "string"
},
"slowpath": {
"description": "The total number of packets per second (pps) received from slowpath threads for the last 100ms.",
"readonly": true,
"title": "CPU slowpath packet rate",
"type": "string"
},
"tx": {
"description": "The total number of packets per second (pps) transmitted from NICs for the last 100ms. This also includes the packets dropped due to Tx ring full.",
"readonly": true,
"title": "CPU Tx packet rate",
"type": "string"
},
"usage": {
"description": "Provides the percentage of live CPU utilisation of the core sampled within the last 60 seconds.",
"readonly": true,
"title": "CPU usage",
"type": "string"
}
},
"title": "CPU core statistics",
"type": "object"
}
CreateRemoteDirectoryProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "CopyRemoteFileProperties
},
"id": "CreateRemoteDirectoryProperties",
"properties": {
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Server port",
"type": "integer"
},
"preserve_file_properties": {
"default": true,
"required": false,
"title": "Preserve file properties flag",
"type": "boolean"
},
"protocol": {
"$ref": "SftpProtocol,
"required": true,
"title": "Protocol to use to copy file"
},
"server": {
"pattern": "^.+$",
"required": true,
"title": "Remote server hostname or IP address",
"type": "string"
},
"uri": {
"required": true,
"title": "URI of file to copy",
"type": "string"
}
},
"type": "object"
}
Crl (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ManagedResource
},
"id": "Crl",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"details": {
"$ref": "X509Crl,
"description": "details of the X509Crl object",
"readonly": true,
"required": false
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"pem_encoded": {
"description": "pem encoded crl data",
"readonly": false,
"required": true,
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}
CrlList (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListResult
},
"id": "CrlList",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"description": "CRL list",
"items": {
"$ref": "Crl
},
"readonly": true,
"required": true,
"type": "array"
}
},
"title": "Crl queries result",
"type": "object"
}
CrlObjectData (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ManagedResource
},
"id": "CrlObjectData",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"pem_encoded": {
"description": "pem encoded crl data",
"readonly": false,
"required": true,
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}
DHGroup (type)
{
"additionalProperties": false,
"description": "Diffie-Hellman groups represent algorithm used to derive shared keys between IPSec VPN initiator and responder over an unsecured network. GROUP2 uses 1024-bit Modular Exponentiation (MODP) group. GROUP5 uses 1536-bit MODP group. GROUP14 uses 2048-bit MODP group. GROUP15 uses 3072-bit MODP group. GROUP16 uses 4096-bit MODP group. GROUP19 uses 256-bit random Elliptic Curve (ECP) group. GROUP20 uses 384-bit random ECP group. GROUP21 uses 521-bit random ECP group.",
"enum": [
"GROUP2",
"GROUP5",
"GROUP14",
"GROUP15",
"GROUP16",
"GROUP19",
"GROUP20",
"GROUP21"
],
"id": "DHGroup",
"title": "Diffie-Hellman groups",
"type": "string"
}
DatetimeUTC (type)
{
"description": "Datetime string in UTC in the RFC3339 format 'yyyy-mm-ddThh:mm:ssZ'",
"id": "DatetimeUTC",
"title": "Datetime string in UTC",
"type": "string"
}
DeleteRemoteDirectoryProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "CopyRemoteFileProperties
},
"id": "DeleteRemoteDirectoryProperties",
"properties": {
"directory_path": {
"description": "Directory Path which needs to be retained",
"required": false,
"title": "Directory Path",
"type": "string"
},
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Server port",
"type": "integer"
},
"preserve_file_properties": {
"default": true,
"required": false,
"title": "Preserve file properties flag",
"type": "boolean"
},
"protocol": {
"$ref": "SftpProtocol,
"description": "Protocol to use to delete directory",
"required": true,
"title": "Protocol to use to delete directory"
},
"server": {
"pattern": "^.+$",
"required": true,
"title": "Remote server hostname or IP address",
"type": "string"
},
"uri": {
"required": true,
"title": "URI of file to copy",
"type": "string"
}
},
"type": "object"
}
EdgeConfigDiagnosis (type)
{
"additionalProperties": false,
"id": "EdgeConfigDiagnosis",
"properties": {
"failed": {
"$ref": "FailedOrWarningConfig,
"required": true,
"title": "Failed Config",
"type": "object"
},
"passed": {
"items": {
"$ref": "ConfigType
},
"required": true,
"title": "Passed Config",
"type": "array"
},
"warning": {
"$ref": "FailedOrWarningConfig,
"required": true,
"title": "Config Warning",
"type": "object"
}
},
"type": "object"
}
EdgeDataplaneCpuStats (type)
{
"additionalProperties": false,
"description": "Provides the dataplane CPU statistics per CPU core for a given edge transport node. It includes the following information: - Core ID. - CPU type. - Number of packets sent and received per second on the core for the last 100ms. - Number of packets received per second from the crypto module, the KNI interface, the slowpath threads and the other cores within the last 100ms. - Statistics of the mega flow cache which holds flow cache key and the corresponding flow cache actions for all the entries. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart. - Statistics of the micro flow cache which holds a hash of the entire flow cache key and a pointer to the mega flow cache entry. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart. - Percentage of live CPU utilization of the core sampled within the last 60 seconds. - Percentage of CPU utilization of the core for actual packet processing for the last 100ms.",
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneCpuStats",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"cores": {
"description": "Provides the per-core CPU statistics of an edge transport node for the last 100ms. It includes the number of packets sent and received per second; the number of packets received from the crypto module, the other cores, the Kernel Network interface (KNI), and the slowpath threads per second and the CPU packet processing usage. It also provides the live CPU usage of the core sampled within the last 60 seconds. It includes the flow cache statistics since the time the edge dataplane is UP. The flow cache statistics will be reset on edge reboot or edge dataplane restart.",
"items": {
"$ref": "CpuStats
},
"maxItems": 64,
"title": "Statistics of all CPU cores",
"type": "array"
},
"datapath_cores_mode": {
"description": "Mode of how the datapath cores get the packets from driver",
"readonly": true,
"title": "Datapath core mode",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Edge dataplane CPU stats",
"type": "object"
}
EdgeDataplaneCtrlPrioSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneCtrlPrioSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"ctrl_prio_enabled": {
"description": "Control packet prioritization setting",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Information about Edge Dataplane control packet prioritization setting.",
"type": "object"
}
EdgeDataplaneFlow (type)
{
"additionalProperties": false,
"id": "EdgeDataplaneFlow",
"properties": {
"dst_ip": {
"description": "Destination IP of the flow",
"title": "Destination IP",
"type": "string"
},
"dst_port": {
"description": "Destination port of the flow",
"title": "Destination port",
"type": "integer"
},
"proto": {
"description": "Protocol of the flow",
"title": "Protocol",
"type": "integer"
},
"src_ip": {
"description": "Source IP of the flow",
"title": "Source IP",
"type": "string"
},
"src_port": {
"description": "Source port of the flow",
"title": "Source port",
"type": "integer"
},
"tunnel_dst_ip": {
"description": "Tunnel destination IP of the flow",
"title": "Tunnel destination IP",
"type": "string"
},
"tunnel_src_ip": {
"description": "Tunnel source IP of the flow",
"title": "Tunnel source IP",
"type": "string"
}
},
"title": "Edge dataplane flow record",
"type": "object"
}
EdgeDataplaneFlowCacheSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneFlowCacheSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"flow_cache_enabled": {
"description": "Flow cache setting",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Information about Edge Dataplane Flow Cache mode.",
"type": "object"
}
EdgeDataplaneFlowMonitorMessage (type)
{
"additionalProperties": false,
"id": "EdgeDataplaneFlowMonitorMessage",
"properties": {
"message": {
"description": "Edge dataplane flow monitor message",
"title": "Message",
"type": "string"
}
},
"title": "Edge dataplane flow monitor message",
"type": "object"
}
EdgeDataplaneFlowMonitorStartSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneFlowMonitorStartSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"core_id": {
"description": "Flow monitor core id",
"title": "Core id",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"timeout": {
"default": "15",
"description": "Flow monitor timeout in seconds",
"title": "Timeout for flow monitor in seconds, in the range of 1 - 600.",
"type": "string"
}
},
"title": "Information about Edge Dataplane flow monitor start setting.",
"type": "object"
}
EdgeDataplaneFlowQueryParameters (type)
{
"extends": {
"$ref": "ListResultQueryParameters
},
"id": "EdgeDataplaneFlowQueryParameters",
"properties": {
"fields": {
"description": "Comma-separated field names to include in query result",
"title": "Fields to include in query results",
"type": "string"
},
"top_10": {
"default": false,
"description": "Collect top 10 flows when set to true, else collect all flows.",
"title": "Collect top 10 flows when set to true",
"type": "boolean"
}
},
"type": "object"
}
EdgeDataplaneGeneveCbitSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneGeneveCbitSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"geneve_cbit_set": {
"description": "geneve critical bit setting",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Information about Edge Dataplane geneve cbit setting.",
"type": "object"
}
EdgeDataplaneIntrModeSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneIntrModeSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"intr_mode_enabled": {
"description": "interrupt mode setting",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Information about Edge Dataplane interrupt mode setting.",
"type": "object"
}
EdgeDataplaneL2vpnPmtuSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneL2vpnPmtuSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"l2vpn_pmtu_enabled": {
"description": "l2vpn pmtu setting",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Information about Edge Dataplane l2vpn pmtu message generation setting.",
"type": "object"
}
EdgeDataplanePmtuLearningSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplanePmtuLearningSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"pmtu_learning_enabled": {
"description": "l3vpn pmtu setting",
"type": "boolean"
}
},
"title": "Information about Edge Dataplane pmtu learning setting.",
"type": "object"
}
EdgeDataplaneQatAdminSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneQatAdminSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"qat_admin_enabled": {
"description": "QAT feature enabled setting",
"type": "boolean"
}
},
"title": "Information about Edge Dataplane QAT feature enabled setting.",
"type": "object"
}
EdgeDataplaneQatAdminSettingResponse (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneQatAdminSettingResponse",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"update_message": {
"description": "Message to display after setting QAT feature",
"readonly": true,
"title": "Datapath QAT enable CLI message",
"type": "string"
}
},
"title": "Information about Edge Dataplane QAT feature enabled setting.",
"type": "object"
}
EdgeDataplaneQatStatus (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneQatStatus",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"admin_status": {
"description": "QAT device enabled",
"readonly": true,
"title": "QAT enabled",
"type": "boolean"
},
"device_present": {
"description": "QAT device present",
"readonly": true,
"title": "QAT present",
"type": "boolean"
},
"fips_compliant": {
"description": "FIPS compliance of QAT feature",
"readonly": true,
"title": "FIPS compliance",
"type": "boolean"
},
"is_vm": {
"description": "Edge is deployed in VM",
"readonly": true,
"title": "VM deployment",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"operational_status": {
"description": "QAT device currently running",
"readonly": true,
"title": "QAT running",
"type": "boolean"
}
},
"title": "Information about Edge Dataplane QAT status",
"type": "object"
}
EdgeDataplaneQueueNumPerPortPerCoreSetting (type)
{
"additionalProperties": false,
"description": "Provides information about the number of receive(Rx) and transmit(Tx) queue per port per core on the edge transport node.",
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneQueueNumPerPortPerCoreSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"queue_num_per_port_per_core": {
"description": "The total number of receive(Rx) and transmit(Tx) queues that edge dataplane allocates per port per core.",
"maximum": 16,
"minimum": 1,
"title": "Queue number per port per core",
"type": "integer"
}
},
"title": "Rx and Tx queue number",
"type": "object"
}
EdgeDataplaneRingSize (type)
{
"additionalProperties": false,
"description": "Provides information about the receive(Rx) and transmit(Tx) ring buffer size of the edge dataplane. These buffers store the incoming and outgoing packets on the edge NIC respectively.",
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneRingSize",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"rx_ring_size": {
"description": "The size of the ring buffer which stores the incoming packets on the edge NIC before they are processed.",
"title": "Rx ring size",
"type": "integer"
},
"tx_ring_size": {
"description": "The size of the ring buffer which stores the packets to be sent out from the edge NIC.",
"title": "Tx ring size",
"type": "integer"
}
},
"title": "Edge dataplane ring size",
"type": "object"
}
EdgeDataplaneRingSizeSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneRingSizeSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"ring_size": {
"description": "ring size",
"type": "integer"
}
},
"title": "Information about Edge physical port ring size setting.",
"type": "object"
}
EdgeDataplaneTopKFlowQueryParameters (type)
{
"extends": {
"$ref": "ListResultQueryParameters
},
"id": "EdgeDataplaneTopKFlowQueryParameters",
"properties": {
"core_id": {
"description": "CPU core on which the flows are to be monitored",
"maximum": 128,
"minimum": 0,
"title": "CPU core on which the flows are to be monitored",
"type": "integer"
},
"fields": {
"description": "Comma-separated field names to include in query result",
"title": "Fields to include in query results",
"type": "string"
},
"timeout": {
"default": 30,
"description": "Timeout for flow monitor in seconds",
"maximum": 120,
"minimum": 1,
"title": "Timeout for flow monitor in seconds",
"type": "integer"
}
},
"type": "object"
}
EdgeDataplaneTopKFlows (type)
{
"id": "EdgeDataplaneTopKFlows",
"properties": {
"flow_count": {
"description": "Count of flow records in the result",
"title": "Count of flow records",
"type": "integer"
},
"flows": {
"description": "Array of flow records",
"items": {
"$ref": "EdgeDataplaneFlow
},
"title": "Array of flow records",
"type": "array"
}
},
"title": "Edge dataplane top-k flow dump",
"type": "object"
}
EdgeDataplaneUptModeSetting (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "EdgeDataplaneUptModeSetting",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"upt_mode_enabled": {
"default": false,
"description": "UPT (Uniform Pass Thru) mode setting",
"type": "boolean"
}
},
"title": "Information about Edge Dataplane UPT mode setting.",
"type": "object"
}
EdgeDiagnosis (type)
{
"additionalProperties": false,
"id": "EdgeDiagnosis",
"properties": {
"config": {
"$ref": "EdgeConfigDiagnosis,
"required": true,
"title": "Edge Config Diagnosis",
"type": "object"
},
"ha-state": {
"enum": [
"disabled",
"offline",
"discover",
"statesync",
"inactive",
"active",
"unknown"
],
"required": true,
"title": "HA State",
"type": "string"
}
},
"type": "object"
}
EdgeDiagnosisInconsistency (type)
{
"id": "EdgeDiagnosisInconsistency",
"properties": {
"detail": {
"description": "NSX Edge inconsistency check detail",
"items": {
"type": "string"
},
"title": "NSX Edge inconsistency check detail",
"type": "array"
},
"title": {
"description": "NSX Edge inconsistency check type",
"title": "NSX Edge inconsistency check type",
"type": "string"
}
},
"title": "NSX Edge inconsistency check",
"type": "object"
}
EdgeDiagnosisInconsistencyResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "EdgeDiagnosisInconsistencyResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "EdgeDiagnosisInconsistency
},
"title": "NSX Edge inconsistency check result",
"type": "array"
}
},
"title": "NSX Edge inconsistency check result",
"type": "object"
}
EdgeInconsistencyQueryParameters (type)
{
"additionalProperties": false,
"id": "EdgeInconsistencyQueryParameters",
"properties": {
"cursor": {
"description": "A cursor points to a specific record in the inconsistency check result",
"minimum": 0,
"required": false,
"title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"type": "integer"
},
"page_size": {
"description": "The page size determines the number of records to be returned",
"maximum": 100,
"minimum": 1,
"required": false,
"title": "Maximum number of results to return in this page (server may return fewer)",
"type": "integer"
}
},
"type": "object"
}
EdgeNodeServiceLoggingProperties (type)
{
"extends": {
"$ref": "NodeServiceProperties
},
"id": "EdgeNodeServiceLoggingProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"service_name": {
"required": true,
"title": "Service name",
"type": "string"
},
"service_properties": {
"logging_level": {
"enum": [
"OFF",
"FATAL",
"ERROR",
"WARN",
"INFO",
"DEBUG",
"TRACE"
],
"required": true,
"title": "Service logging level",
"type": "string"
}
}
},
"title": "Edge node service properties",
"type": "object"
}
EdgeNodeServiceLoggingReadOnlyProperties (type)
{
"extends": {
"$ref": "NodeServiceProperties
},
"id": "EdgeNodeServiceLoggingReadOnlyProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"service_name": {
"required": true,
"title": "Service name",
"type": "string"
},
"service_properties": {
"logging_level": {
"enum": [
"OFF",
"FATAL",
"ERROR",
"WARN",
"INFO",
"DEBUG",
"TRACE"
],
"readonly": true,
"required": true,
"title": "Service logging level",
"type": "string"
}
}
},
"title": "Edge node service properties",
"type": "object"
}
EmbeddedResource (type)
{
"abstract": true,
"extends": {
"$ref": "RevisionedResource
},
"id": "EmbeddedResource",
"polymorphic-type-descriptor": {
"property-name": "resource_type"
},
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_owner": {
"$ref": "OwnerResourceLink,
"readonly": true,
"title": "Owner of this resource"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"description": "Identifier of the resource",
"readonly": true,
"required": false,
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
}
},
"title": "Base class for resources that are embedded in other resources",
"type": "object"
}
EpochMsTimestamp (type)
{
"id": "EpochMsTimestamp",
"title": "Timestamp in milliseconds since epoch",
"type": "integer"
}
ExitEdgeInterface (type)
{
"enum": [
"eth1",
"eth2",
"eth3",
"eth4",
"eth5",
"eth6",
"eth7",
"eth8"
],
"id": "ExitEdgeInterface",
"title": "Exit interface for logical router port",
"type": "string"
}
FailedOrWarningConfig (type)
{
"additionalProperties": false,
"id": "FailedOrWarningConfig",
"properties": {
"controller": {
"title": "Controller Connection State",
"type": "string"
},
"core": {
"items": {
"type": "string"
},
"title": "Core Names",
"type": "array"
},
"dataplane": {
"title": "Dataplane State",
"type": "string"
},
"edge-agent": {
"title": "Edge Agent State",
"type": "string"
},
"manager": {
"title": "Manager Connection State",
"type": "string"
},
"nestdb": {
"title": "NestDB State",
"type": "string"
},
"nsd": {
"title": "Nsd State",
"type": "string"
},
"nsxa-edge-cluster": {
"title": "Edge Cluster State",
"type": "string"
},
"nsxa-lrouter": {
"title": "Logical Router State",
"type": "string"
},
"nsxa-service-router": {
"title": "Service Router State",
"type": "string"
},
"nsxa-state": {
"title": "NSXA State",
"type": "string"
}
},
"title": "Failed or Warning Config",
"type": "object"
}
FileProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "FileProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"created_epoch_ms": {
"required": true,
"title": "File creation time in epoch milliseconds",
"type": "integer"
},
"modified_epoch_ms": {
"required": true,
"title": "File modification time in epoch milliseconds",
"type": "integer"
},
"name": {
"pattern": "^[^/]+$",
"required": true,
"title": "File name",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"path": {
"readonly": true,
"title": "File path",
"type": "string"
},
"size": {
"required": true,
"title": "Size of the file in bytes",
"type": "integer"
}
},
"title": "File properties",
"type": "object"
}
FilePropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "FilePropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "FileProperties
},
"required": true,
"title": "File property results",
"type": "array"
}
},
"title": "File properties query results",
"type": "object"
}
FileThumbprint (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "FileThumbprint",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"name": {
"pattern": "^[^/]+$",
"required": true,
"title": "File name",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"sha1": {
"deprecated": true,
"deprecation_advice": "Deprecated by EAL4. Please use the sha256 thumbprint instead.",
"required": true,
"title": "File's SHA1 thumbprint",
"type": "string"
},
"sha256": {
"required": true,
"title": "File's SHA256 thumbprint",
"type": "string"
}
},
"title": "File thumbprint",
"type": "object"
}
FlowCacheStatistics (type)
{
"additionalProperties": false,
"description": "Provides the following statistics for flow cache since the time the edge dataplane is UP: - Number of active entries. - Number of cache entry insertions. - Number of bucket collisions when the entry insertion happens to a bucket which is full. - Number of key collisions when the entry to be inserted has a key colliding with that of an existing entry. - Number of cache hits, hit_rate, misses and skips. - Number of packets that cannot be cached. - Number of maximum entries with respect to size.",
"id": "FlowCacheStatistics",
"properties": {
"active": {
"description": "The number of current active entries in the flow cache.",
"title": "Active",
"type": "string"
},
"bucket_collisions": {
"description": "The total number of times when during an entry insertion, the corresponding bucket is full with unexpired entries. This collision will result in a flow cache miss. This is valid only for mega flow cache. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Bucket collisions",
"type": "string"
},
"dont_cache": {
"description": "The total number of packets that cannot be cached. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Dont cache",
"type": "string"
},
"hit_rate": {
"description": "The rate at which the packets matching the flow cache are forwarded. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Hit rate",
"type": "string"
},
"hits": {
"description": "The total number of packets forwarded due to matching flow cache entry. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Hits",
"type": "string"
},
"insertions": {
"description": "The total number of times a new flow cache entry is added. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Insertions",
"type": "string"
},
"key_collisions": {
"description": "The total number of times a newly inserted entry has a key colliding with that of an existing entry. In this case, the new entry will replace the existing entry. This is only valid for mega flow cache. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Key collisions",
"type": "string"
},
"max_seen_percentage": {
"description": "The percentage of maximum entries in a flow cache with respect to total size. This is collected from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Max seen percentage",
"type": "string"
},
"misses": {
"description": "The total number of packets passed on to the next layer due to cache miss. The next layer can be either slow path (in case of megaflow cache) or megaflow cache (in case of microflow cache). The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Misses",
"type": "string"
},
"skipped": {
"description": "The total number of packet misses due to unsupported packet type or the cache is disabled. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"title": "Skipped",
"type": "string"
}
},
"title": "Flow cache statistics",
"type": "object"
}
GetCertParameter (type)
{
"additionalProperties": false,
"id": "GetCertParameter",
"properties": {
"details": {
"default": false,
"required": false,
"title": "whether to expand the pem data and show all its details",
"type": "boolean"
}
},
"type": "object"
}
GetSNMPParameters (type)
{
"additionalProperties": false,
"description": "Get SNMP request parameters.",
"id": "GetSNMPParameters",
"properties": {
"show_sensitive_data": {
"default": false,
"description": "Whether to show SNMP service properties including community strings if any applicable.",
"required": false,
"title": "Show SNMP sensitive data or not",
"type": "boolean"
}
},
"title": "Get SNMP request parameters",
"type": "object"
}
HANodeStatusProperties (type)
{
"id": "HANodeStatusProperties",
"properties": {
"admin_state": {
"$ref": "NodeAdminState,
"title": "Node Admin State"
},
"high_availability_status": {
"$ref": "NodeHAStatus,
"title": "Node High Availability Status"
},
"node_status": {
"$ref": "NodeStatus,
"title": "Actual Node Status"
},
"vtep_state": {
"$ref": "NodeVtepState,
"description": "State of VTEP interfaces. All VTEPs share the same state."
}
},
"type": "object"
}
HaInfo (type)
{
"id": "HaInfo",
"properties": {
"failover_mode": {
"description": "Logical router failover mode",
"enum": [
"PREEMPTIVE",
"NON-PREEMPTIVE"
],
"readonly": true,
"title": "Logical router failover mode",
"type": "string"
},
"ha_mode": {
"description": "Logical router HA mode",
"enum": [
"ACTIVE-STANDBY",
"ACTIVE-ACTIVE"
],
"readonly": true,
"title": "Logical router HA mode",
"type": "string"
},
"ha_state": {
"description": "Logical router HA state DOWN - Logical router is not in good health SYNC - Logical router is synchronizing data from peer logical router STANDBY - Logical router is available to go Active ACTIVE - Logical router is forwarding traffic",
"enum": [
"DOWN",
"SYNC",
"STANDBY",
"ACTIVE"
],
"readonly": true,
"title": "Logical router HA state",
"type": "string"
},
"rank": {
"description": "Rank of logical router",
"readonly": true,
"title": "Rank of logical router",
"type": "integer"
},
"state-history": {
"$ref": "LogicalRouterHaHistory,
"description": "Logical router high-availability history",
"readonly": true,
"title": "Logical router high-availability history"
}
},
"type": "object"
}
HostKeyAlgorithms (type)
{
"enum": [
"ecdsa-sha2-nistp256",
"ecdsa-sha2-nistp384",
"ecdsa-sha2-nistp521",
"ssh-dss",
"ssh-ed25519",
"ssh-rsa"
],
"id": "HostKeyAlgorithms",
"title": "SSH key type",
"type": "string"
}
HostnameOrIPv46Address (type)
{
"id": "HostnameOrIPv46Address",
"maxLength": 255,
"pattern": "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\\.?$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$",
"title": "Hostname or IPv4 or IPv6 address",
"type": "string"
}
HttpProtocol (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Protocol
},
"id": "HttpProtocol",
"polymorphic-type-descriptor": {
"type-identifier": "http"
},
"properties": {
"authentication_scheme": {
"$ref": "BasicAuthenticationScheme,
"title": "Scheme to authenticate if required"
},
"name": {
"enum": [
"http",
"https",
"scp",
"sftp"
],
"required": true,
"title": "Protocol name",
"type": "string"
}
},
"type": "object"
}
HttpsProtocol (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Protocol
},
"id": "HttpsProtocol",
"polymorphic-type-descriptor": {
"type-identifier": "https"
},
"properties": {
"authentication_scheme": {
"$ref": "BasicAuthenticationScheme,
"title": "Scheme to authenticate if required"
},
"name": {
"enum": [
"http",
"https",
"scp",
"sftp"
],
"required": true,
"title": "Protocol name",
"type": "string"
},
"sha256_thumbprint": {
"required": true,
"title": "SSL thumbprint of server",
"type": "string"
}
},
"type": "object"
}
IKEDigestAlgorithm (type)
{
"additionalProperties": false,
"description": "The IKEDigestAlgorithms are used to verify message integrity during IKE negotiation. SHA1 produces 160 bits hash and SHA2_XXX produces XXX bit hash.",
"enum": [
"SHA1",
"SHA2_256",
"SHA2_384",
"SHA2_512"
],
"id": "IKEDigestAlgorithm",
"title": "Digest Algorithms used in IKE negotiations",
"type": "string"
}
IKEEncryptionAlgorithm (type)
{
"additionalProperties": false,
"description": "IKEEncryption algorithms are used to ensure confidentiality of the messages exchanged during IKE negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode(GCM) and is used to provide both confidentiality and data origin authentication. AES_GCM composed of two separate functions one for encryption(AES) and one for authentication(GMAC). AES_GCM algorithms will be available with IKE_V2 version only. AES_GCM_128 uses 128-bit keys. AES_GCM_192 uses 192-bit keys. AES_GCM_256 uses 256-bit keys.",
"enum": [
"AES_128",
"AES_256",
"AES_GCM_128",
"AES_GCM_192",
"AES_GCM_256"
],
"id": "IKEEncryptionAlgorithm",
"title": "Encryption algorithms used in IKE",
"type": "string"
}
IPCIDRBlock (type)
{
"id": "IPCIDRBlock",
"title": "IPv4 or IPv6 CIDR Block",
"type": "string"
}
IPSecMultiPathGroup (type)
{
"additionalProperties": false,
"description": "Configuration to allow IPSec VPN traffic through multipaths.",
"extends": {
"$ref": "ManagedResource
},
"id": "IPSecMultiPathGroup",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enabled": {
"default": false,
"description": "If true, enable IPSec VPN multipath group.",
"title": "Enable IPSec VPN multipath group",
"type": "boolean"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"ipsec_vpn_session_ids": {
"description": "List of all IPSec VPN session Ids that are using this multipath group.",
"items": {
"type": "string"
},
"readonly": true,
"title": "List of IPSec VPN session Ids that are using this multipath group",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"scheme": {
"default": "THRESHOLD_BASED",
"description": "Specify a scheme to probe the quality of different paths for IPSec VPN traffic and to select the best equally good paths. THRESHOLD_BASED: The best paths are selected based on the threshold limit configured.",
"enum": [
"THRESHOLD_BASED"
],
"title": "The scheme specified to decide best paths"
},
"scheme_value": {
"description": "If scheme is THRESHOLD_BASED, scheme_value represents margin above the average path metric used for selecting the best paths. Paths below the specified threshold are considered good while above the selected threshold are considered bad quality. Threshold is a percentage value in the range of [0-100]. If not specified, the default is 20.",
"title": "The value specified for the scheme",
"type": "integer"
},
"source_port_pool_size": {
"default": 7,
"description": "The maximum number of best paths allowed for an IPSec VPN session. For each path, a UDP source port number is assigned from an internal source port pool for encapsulating the IPSec VPN traffic through the path.",
"maximum": 7,
"minimum": 2,
"title": "The size of the source port pool",
"type": "integer"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"title": "IPSec VPN multipath group",
"type": "object"
}
IPSecMultiPathGroupListResult (type)
{
"additionalProperties": false,
"description": "List all the IPSec multipath groups.",
"extends": {
"$ref": "ListResult
},
"id": "IPSecMultiPathGroupListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "IPSecMultiPathGroup
},
"required": true,
"title": "IPSec multipath group list results",
"type": "array"
}
},
"title": "List of IPSec multipath groups",
"type": "object"
}
IPSecVPNDPDProfile (type)
{
"additionalProperties": false,
"description": "Dead peer detection (DPD) is a method that allows detection of unreachable internet key excahnge (IKE) peers. Any changes affects all IPSec VPN sessions consuming this profile.",
"extends": {
"$ref": "ManagedResource
},
"id": "IPSecVPNDPDProfile",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"dpd_probe_interval": {
"description": "When the DPD probe mode is periodic, this interval is the number of seconds between DPD messages. When the DPD probe mode is on-demand, this interval is the number of seconds during which traffic is not received from the peer before DPD retry messages are sent if there is IPSec traffic to send. For PERIODIC Mode: Minimum: 3 Maximum: 360 Default: 60 For ON_DEMAND Mode: Minimum: 1 Maximum: 10 Default: 3",
"maximum": 360,
"minimum": 1,
"required": false,
"title": "DPD probe interval defines an interval for DPD probes (in seconds)",
"type": "integer"
},
"dpd_probe_mode": {
"default": "PERIODIC",
"description": "DPD probe mode is used to query the liveliness of the peer. Two modes are possible - PERIODIC - is used to query the liveliness of the peer at regular intervals (dpd_probe_interval). It does not take into consideration traffic coming from the peer. The benefit of this mode over the on-demand mode is earlier detection of dead peers. However, use of periodic DPD incurs extra overhead. When communicating to large numbers of peers, please consider using on-demand DPD instead. ON_DEMAND - is used to query the liveliness of the peer by instructing the local endpoint to send DPD message to a peer if there is traffic to send to the peer AND the peer was idle for dpd_probe_interval seconds (i.e. there was no traffic from the peer for dpd_probe_interval seconds)",
"enum": [
"PERIODIC",
"ON_DEMAND"
],
"title": "DPD probe mode",
"type": "string"
},
"enabled": {
"default": true,
"description": "If true, enable dead peer detection.",
"title": "Enable dead peer detection (DPD)",
"type": "boolean"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"is_default": {
"description": "It is a boolean flag which reflects whether a profile is created and owned by system or not. If the session creation/update does not define a profile, this default profile will be used. Default profiles cannot be edited or deleted. If the sessions needs different settings, please create a new profile.",
"readonly": true,
"required": false,
"title": "Default Profile",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"retry_count": {
"default": 5,
"description": "Maximum number of DPD messages retry attempts. This value is applicable for both dpd probe modes, periodic and on-demand.",
"maximum": 100,
"minimum": 1,
"title": "Retry count",
"type": "integer"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"title": "Dead peer detection (DPD) profile",
"type": "object"
}
IPSecVPNDPDProfileListResult (type)
{
"additionalProperties": false,
"description": "List all the dead peer detection (DPD) profiles.",
"extends": {
"$ref": "ListResult
},
"id": "IPSecVPNDPDProfileListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "IPSecVPNDPDProfile
},
"required": true,
"title": "IPSec DPD Profile list results",
"type": "array"
}
},
"title": "List dead peer detection (DPD) profiles",
"type": "object"
}
IPSecVPNIKEProfile (type)
{
"additionalProperties": false,
"description": "IKE Profile is a reusable profile that captures IKE phase one negotiation parameters. Any changes affects all IPSec VPN sessions consuming this profile.",
"extends": {
"$ref": "ManagedResource
},
"id": "IPSecVPNIKEProfile",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"dh_groups": {
"description": "Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.",
"items": {
"$ref": "DHGroup
},
"required": false,
"title": "DH group",
"type": "array"
},
"digest_algorithms": {
"description": "Algorithm used for message digest during Internet Key Exchange(IKE) negotiation. Default is SHA2_256.",
"items": {
"$ref": "IKEDigestAlgorithm
},
"required": false,
"title": "Algorithm for message hash",
"type": "array"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"encryption_algorithms": {
"description": "Encryption algorithm used during Internet Key Exchange(IKE) negotiation. Default is AES_128.",
"items": {
"$ref": "IKEEncryptionAlgorithm
},
"required": false,
"title": "Encryption algorithm for IKE",
"type": "array"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"ike_version": {
"default": "IKE_V2",
"description": "IKE protocol version to be used. IKE-Flex will initiate IKE-V2 and responds to both IKE-V1 and IKE-V2.",
"enum": [
"IKE_V1",
"IKE_V2",
"IKE_FLEX"
],
"title": "IKE version",
"type": "string"
},
"is_default": {
"description": "It is a boolean flag which reflects whether a profile is created and owned by system or not. If the session creation/update does not define a profile, this default profile will be used. Default profiles cannot be edited or deleted. If the sessions needs different settings, please create a new profile.",
"readonly": true,
"required": false,
"title": "Default Profile",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"sa_life_time": {
"default": 86400,
"description": "Life time for security association. Default is 86400 seconds (1 day).",
"maximum": 31536000,
"minimum": 21600,
"title": "Security association (SA) life time",
"type": "integer"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"title": "Internet key exchange (IKE) profile",
"type": "object"
}
IPSecVPNIKEProfileListResult (type)
{
"additionalProperties": false,
"description": "List all the IKE profiles.",
"extends": {
"$ref": "ListResult
},
"id": "IPSecVPNIKEProfileListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "IPSecVPNIKEProfile
},
"required": true,
"title": "IKE Profile list results",
"type": "array"
}
},
"title": "List IKE profiles",
"type": "object"
}
IPSecVPNIKESessionStatus (type)
{
"additionalProperties": false,
"description": "Status for IPSec VPN IKE session UP, DOWN, NEGOTIATING and fail reason if IKE session is down.",
"id": "IPSecVPNIKESessionStatus",
"properties": {
"fail_reason": {
"description": "Reason for failure.",
"readonly": true,
"title": "Fail reason",
"type": "string"
},
"ike_session_state": {
"description": "IKE session service status UP, DOWN and NEGOTIATING.",
"enum": [
"UP",
"DOWN",
"NEGOTIATING"
],
"readonly": true,
"title": "IKE session state",
"type": "string"
}
},
"title": "IKE session status",
"type": "object"
}
IPSecVPNLocalEndpoint (type)
{
"additionalProperties": false,
"description": "Local endpoint represents a logical router on which tunnel needs to be terminated.",
"id": "IPSecVPNLocalEndpoint",
"properties": {
"certificate_id": {
"description": "Site certificate identifier.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"required": false,
"title": "Certificate Id",
"type": "string"
},
"local_address": {
"$ref": "IPv4Address,
"description": "IPV4 Address for local endpoint.",
"required": true,
"title": "IPV4 Address for local endpoint"
},
"local_id": {
"description": "Local identifier. Only one Local id is allowed for a local address.",
"title": "Local identifier",
"type": "string"
},
"trust_ca_ids": {
"description": "Certificate authority (CA) identifier list to verify peer certificates.",
"items": {
"type": "string"
},
"required": false,
"title": "Certificate authority (CA) identifiers",
"type": "array"
},
"trust_crl_ids": {
"description": "Certificate revocation list (CRL) identifier list of peer certificates.",
"items": {
"type": "string"
},
"required": false,
"title": "Certificate revocation list (CRL) Identifiers",
"type": "array"
}
},
"title": "IPSec VPN Local Endpoint",
"type": "object"
}
IPSecVPNPolicyRule (type)
{
"additionalProperties": false,
"description": "For policy-based IPsec VPNs, a security policy specifies as its action the VPN tunnel to be used for transit traffic that meets the policy's match criteria.",
"extends": {
"$ref": "EmbeddedResource
},
"id": "IPSecVPNPolicyRule",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_owner": {
"$ref": "OwnerResourceLink,
"readonly": true,
"title": "Owner of this resource"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"action": {
"default": "PROTECT",
"description": "PROTECT - Protect rules are defined per policy based IPSec VPN session.",
"enum": [
"PROTECT"
],
"readonly": true,
"title": "Action to be applied",
"type": "string"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"destinations": {
"description": "List of peer subnets.",
"items": {
"$ref": "IPSecVPNPolicySubnet
},
"maxItems": 128,
"required": false,
"title": "Destination list",
"type": "array"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enabled": {
"default": true,
"description": "A flag to enable/disable the policy rule.",
"title": "Enabled flag",
"type": "boolean"
},
"id": {
"description": "Unique policy id.",
"title": "Unique policy id",
"type": "string"
},
"logged": {
"default": false,
"description": "A flag to enable/disable the logging for the policy rule.",
"title": "Logging flag",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"sources": {
"description": "List of local subnets.",
"items": {
"$ref": "IPSecVPNPolicySubnet
},
"maxItems": 128,
"required": false,
"title": "Source list",
"type": "array"
}
},
"title": "IPSec VPN policy rules",
"type": "object"
}
IPSecVPNPolicySubnet (type)
{
"additionalProperties": false,
"description": "Used to specify the local/peer subnets in IPSec VPN Policy rule.",
"id": "IPSecVPNPolicySubnet",
"properties": {
"subnet": {
"$ref": "IPv4CIDRBlock,
"description": "Subnet used in policy rule.",
"required": true,
"title": "Peer or local subnet"
}
},
"title": "Subnet for IPSec Policy based VPN",
"type": "object"
}
IPSecVPNPolicyTrafficStatistics (type)
{
"additionalProperties": false,
"description": "IPSec VPN policy traffic statistics",
"id": "IPSecVPNPolicyTrafficStatistics",
"properties": {
"aggregate_traffic_counters": {
"$ref": "IPSecVPNTrafficCounters,
"description": "Aggregate traffic statistics across all ipsec tunnels.",
"readonly": true,
"title": "Traffic summary"
},
"policy_id": {
"description": "Policy Identifier.",
"readonly": true,
"title": "Policy Identifier",
"type": "string"
},
"tunnel_statistics": {
"description": "Tunnel statistics.",
"items": {
"$ref": "IPSecVPNTunnelTrafficStatistics
},
"readonly": true,
"title": "Tunnel statistics",
"type": "array"
}
},
"title": "IPSec VPN policy traffic statistics",
"type": "object"
}
IPSecVPNService (type)
{
"additionalProperties": false,
"description": "IPSec VPN service for given logical router.",
"extends": {
"$ref": "ManagedResource
},
"id": "IPSecVPNService",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enabled": {
"default": true,
"description": "If true, enable VPN services for given logical router.",
"title": "Enable virtual private network (VPN) service",
"type": "boolean"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"ike_log_level": {
"default": "INFO",
"description": "Log level for internet key exchange (IKE).",
"enum": [
"DEBUG",
"INFO",
"WARN",
"ERROR",
"EMERGENCY"
],
"title": "Internet key exchange (IKE) log level",
"type": "string"
},
"ipsec_ha_sync": {
"default": true,
"description": "Enable/disable IPSec HA state sync. IPSec HA state sync can be disabled in case there are performance issues with the state sync messages. Default is to enable HA Sync.",
"title": "IPSec HA State Sync flag",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"title": "IPSec VPN service",
"type": "object"
}
IPSecVPNSession (type)
{
"abstract": true,
"description": "VPN session defines connection between local and peer endpoint. Untill VPN session is defined configuration is not realized.",
"extends": {
"$ref": "ManagedResource
},
"id": "IPSecVPNSession",
"polymorphic-type-descriptor": {
"mode": "enabled"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"authentication_mode": {
"default": "PSK",
"description": "Authentication mode used for the peer authentication. For PSK (Pre Shared Key) authentication mode, 'psk' property is mandatory and for the CERTIFICATE authentication mode, 'peer_id' property is mandatory.",
"enum": [
"PSK",
"CERTIFICATE"
],
"title": "Authentication Mode",
"type": "string"
},
"connection_initiation_mode": {
"default": "INITIATOR",
"description": "Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.",
"enum": [
"INITIATOR",
"RESPOND_ONLY",
"ON_DEMAND"
],
"title": "Connection initiation mode",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"dpd_profile_id": {
"description": "Dead peer detection (DPD) profile id. Default will be set according to system default policy.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "Dead peer detection (DPD) profile id",
"type": "string"
},
"enabled": {
"default": true,
"description": "Enable/Disable IPSec VPN session.",
"title": "Enable/Disable IPSec VPN session",
"type": "boolean"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"ike_profile_id": {
"description": "IKE profile id to be used. Default will be set according to system default policy.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "Internet key exchange (IKE) profile id",
"type": "string"
},
"ipsec_tunnel_profile_id": {
"description": "Tunnel profile id to be used. By default it will point to system default profile.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "IPSec tunnel profile id",
"type": "string"
},
"local_endpoint": {
"$ref": "IPSecVPNLocalEndpoint,
"description": "Local endpoint.",
"required": true,
"title": "Local endpoint"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"peer_address": {
"description": "IPV4 address of peer endpoint on remote site.",
"required": true,
"title": "IPV4 address of peer endpoint on remote site.",
"type": "string"
},
"peer_id": {
"description": "Peer identifier.",
"required": true,
"title": "Peer id",
"type": "string"
},
"psk": {
"description": "IPSec Pre-shared key. Maximum length of this field is 128 characters. Its required input in PSK authentication mode.",
"maximum": 128,
"minimum": 1,
"required": false,
"sensitive": true,
"title": "Pre-shared key",
"type": "string"
},
"resource_type": {
"$ref": "IPSecVPNSessionResourceType,
"required": true
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"tcp_mss_clamping": {
"$ref": "TcpMssClamping,
"required": false
}
},
"title": "IPSec VPN session",
"type": "object"
}
IPSecVPNSessionListParameters (type)
{
"additionalProperties": false,
"description": "Parameters to get filtered list of IPSec VPN Sessions. The filter parameters are not mutually exclusive and can be used together.",
"id": "IPSecVPNSessionListParameters",
"properties": {
"session_type": {
"$ref": "IPSecVPNSessionResourceType,
"description": "All the IPSec VPN sessions of specified type will be included in the result.",
"required": false,
"title": "Type of the vpn session"
}
},
"title": "List parameters for IPSec VPN Sessions",
"type": "object"
}
IPSecVPNSessionListResult (type)
{
"additionalProperties": false,
"description": "List all the IPSec VPN sessions.",
"extends": {
"$ref": "ListResult
},
"id": "IPSecVPNSessionListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "IPSecVPNSession
},
"required": true,
"title": "IPSec VPN sessions list result",
"type": "array"
}
},
"title": "List IPSec VPN sessions",
"type": "object"
}
IPSecVPNSessionResourceType (type)
{
"additionalProperties": false,
"description": "A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet. A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.",
"enum": [
"PolicyBasedIPSecVPNSession",
"RouteBasedIPSecVPNSession"
],
"id": "IPSecVPNSessionResourceType",
"title": "Resource types of IPsec VPN session",
"type": "string"
}
IPSecVPNSessionStatistics (type)
{
"additionalProperties": false,
"description": "Session statistics gives aggregated statistics of all policies for all the tunnels.",
"id": "IPSecVPNSessionStatistics",
"properties": {
"aggregate_traffic_counters": {
"$ref": "IPSecVPNTrafficCounters,
"description": "Aggregate traffic statistics across all ipsec tunnels.",
"readonly": true,
"title": "Traffic summary"
},
"display_name": {
"description": "Display name of vpn session.",
"readonly": true,
"title": "Display name",
"type": "string"
},
"failed_tunnels": {
"description": "Number of failed tunnels.",
"readonly": true,
"title": "Failed tunnels",
"type": "integer"
},
"ike_status": {
"$ref": "IPSecVPNIKESessionStatus,
"description": "Status for IPSec VPN IKE session UP/DOWN and fail reason if IKE session is down.",
"readonly": true,
"title": "IKE status summary"
},
"ipsec_vpn_session_id": {
"description": "UUID of vpn session.",
"readonly": true,
"title": "Session identifier",
"type": "string"
},
"last_update_timestamp": {
"$ref": "EpochMsTimestamp,
"description": "Timestamp when the data was last updated.",
"readonly": true,
"title": "Last updated timestamp"
},
"negotiated_tunnels": {
"description": "Number of negotiated tunnels.",
"readonly": true,
"title": "Negotiated tunnels",
"type": "integer"
},
"partial_stats": {
"description": "Partial statistics if true specifies that the statistics are only from active node.",
"readonly": true,
"title": "Partial Statistics",
"type": "boolean"
},
"policy_statistics": {
"description": "Gives aggregate traffic statistics across all ipsec tunnels and individual tunnel statistics.",
"items": {
"$ref": "IPSecVPNPolicyTrafficStatistics
},
"readonly": true,
"title": "IPSec policy statistics",
"type": "array"
},
"session_status": {
"description": "Gives session status consolidated using IKE status and tunnel status. It can be UP, DOWN, DEGRADED. If IKE and all tunnels are UP status will be UP, if all down it will be DOWN, otherwise it will be DEGRADED.",
"enum": [
"UP",
"DOWN",
"DEGRADED"
],
"readonly": true,
"title": "Session status",
"type": "string"
},
"total_tunnels": {
"description": "Total number of tunnels.",
"readonly": true,
"title": "Total tunnels",
"type": "integer"
}
},
"title": "IPSec VPN session statistics",
"type": "object"
}
IPSecVPNTrafficCounters (type)
{
"additionalProperties": false,
"description": "Traffic counters for IPSec VPN session.",
"id": "IPSecVPNTrafficCounters",
"properties": {
"bytes_in": {
"description": "Total number of bytes recevied.",
"readonly": true,
"title": "Bytes in",
"type": "integer"
},
"bytes_out": {
"description": "Total number of bytes sent.",
"readonly": true,
"title": "Bytes out",
"type": "integer"
},
"dropped_packets_in": {
"description": "Total number of incoming packets dropped on inbound security association.",
"readonly": true,
"title": "Dropped incoming packets",
"type": "integer"
},
"dropped_packets_out": {
"description": "Total number of outgoing packets dropped on outbound security association.",
"readonly": true,
"title": "Dropped outgoing packets",
"type": "integer"
},
"packets_in": {
"description": "Total number of packets received.",
"readonly": true,
"title": "Packets in",
"type": "integer"
},
"packets_out": {
"description": "Total number of packets sent.",
"readonly": true,
"title": "Packets out",
"type": "integer"
}
},
"title": "IPSec VPN traffic counters",
"type": "object"
}
IPSecVPNTunnelProfile (type)
{
"additionalProperties": false,
"description": "IPSec VPN tunnel profile is a reusable profile that captures phase two negotiation parameters and tunnel properties. Any changes affects all IPSec VPN sessions consuming this profile.",
"extends": {
"$ref": "ManagedResource
},
"id": "IPSecVPNTunnelProfile",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"df_policy": {
"default": "COPY",
"description": "Defragmentation policy helps to handle defragmentation bit present in the inner packet. COPY copies the defragmentation bit from the inner IP packet into the outer packet. CLEAR ignores the defragmentation bit present in the inner packet.",
"enum": [
"COPY",
"CLEAR"
],
"title": "Policy for handling defragmentation bit",
"type": "string"
},
"dh_groups": {
"description": "Diffie-Hellman group to be used if PFS is enabled. Default is GROUP14.",
"items": {
"$ref": "DHGroup
},
"required": false,
"title": "DH group",
"type": "array"
},
"digest_algorithms": {
"description": "Algorithm used for message digest. Default digest algorithm is implicitly covered by default encryption algorithm \"AES_GCM_128\".",
"items": {
"$ref": "TunnelDigestAlgorithm
},
"required": false,
"title": "Algorithm for message hash",
"type": "array"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enable_perfect_forward_secrecy": {
"default": true,
"description": "If true, perfect forward secrecy (PFS) is enabled.",
"title": "Enable perfect forward secrecy",
"type": "boolean"
},
"encapsulation_mode": {
"default": "TUNNEL_MODE",
"description": "Encapsulation Mode to be used for encryption of packet. Tunnel mode protects internal routing information by encrypting IP header of original packet.",
"enum": [
"TUNNEL_MODE"
],
"readonly": true,
"title": "Encapsulation Mode",
"type": "string"
},
"encryption_algorithms": {
"description": "Encryption algorithm to encrypt/decrypt the messages exchanged between IPSec VPN initiator and responder during tunnel negotiation. Default is AES_GCM_128.",
"items": {
"$ref": "TunnelEncryptionAlgorithm
},
"required": false,
"title": "Encryption algorithm to use in tunnel establishement",
"type": "array"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"is_default": {
"description": "It is a boolean flag which reflects whether a profile is created and owned by system or not. If the session creation/update does not define a profile, this default profile will be used. Default profiles cannot be edited or deleted. If the sessions needs different settings, please create a new profile.",
"readonly": true,
"required": false,
"title": "Default Profile",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"sa_life_time": {
"default": 3600,
"description": "SA life time specifies the expiry time of security association. Default is 3600 seconds.",
"maximum": 31536000,
"minimum": 900,
"title": "Security association (SA) life time",
"type": "integer"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"transform_protocol": {
"default": "ESP",
"description": "IPSec transform specifies IPSec security protocol.",
"enum": [
"ESP"
],
"readonly": true,
"title": "Tunnel protocol",
"type": "string"
}
},
"title": "IPSec VPN tunnel profile",
"type": "object"
}
IPSecVPNTunnelProfileListResult (type)
{
"additionalProperties": false,
"description": "List all the tunnel profiles.",
"extends": {
"$ref": "ListResult
},
"id": "IPSecVPNTunnelProfileListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "IPSecVPNTunnelProfile
},
"required": true,
"title": "IPSec Tunnel Profile list results",
"type": "array"
}
},
"title": "List tunnel profiles",
"type": "object"
}
IPSecVPNTunnelTrafficStatistics (type)
{
"additionalProperties": false,
"description": "IPSec VPN tunnel traffic statistics.",
"id": "IPSecVPNTunnelTrafficStatistics",
"properties": {
"bytes_in": {
"description": "Total number of incoming bytes on inbound Security association (SA).",
"readonly": true,
"title": "Bytes in",
"type": "integer"
},
"bytes_out": {
"description": "Total number of outgoing bytes on outbound Security association (SA).",
"readonly": true,
"title": "Bytes out",
"type": "integer"
},
"decryption_failures": {
"description": "Total number of packets dropped due to decryption failures.",
"readonly": true,
"title": "Decryption failures",
"type": "integer"
},
"dropped_packets_in": {
"description": "Total number of incoming packets dropped on inbound security association.",
"readonly": true,
"title": "Dropped incoming packets",
"type": "integer"
},
"dropped_packets_out": {
"description": "Total number of outgoing packets dropped on outbound security association.",
"readonly": true,
"title": "Dropped outgoing packets",
"type": "integer"
},
"encryption_failures": {
"description": "Total number of packets dropped because of failure in encryption.",
"readonly": true,
"title": "Encryption failures",
"type": "integer"
},
"integrity_failures": {
"description": "Total number of packets dropped due to integrity failures.",
"readonly": true,
"title": "Integrity failures",
"type": "integer"
},
"local_subnet": {
"description": "Local subnet to which a tunnel belongs.",
"readonly": true,
"title": "Local subnet",
"type": "string"
},
"nomatching_policy_errors": {
"description": "Number of packets dropped because of no matching policy is available.",
"readonly": true,
"title": "Nomatching Policy errors",
"type": "integer"
},
"packets_in": {
"description": "Total number of incoming packets on inbound Security association (SA).",
"readonly": true,
"title": "Packets in",
"type": "integer"
},
"packets_out": {
"description": "Total number of outgoing packets on outbound Security association (SA).",
"readonly": true,
"title": "Packets out",
"type": "integer"
},
"packets_receive_other_error": {
"description": "Total number of incoming packets dropped on inbound Security association (SA)(misc).",
"readonly": true,
"title": "Packets receive other error",
"type": "integer"
},
"packets_sent_other_error": {
"description": "Total number of packets dropped while sending for any reason.",
"readonly": true,
"title": "Packets sent other error",
"type": "integer"
},
"peer_subnet": {
"description": "Peer subnet to which a tunnel belongs.",
"readonly": true,
"title": "Peer subnet",
"type": "string"
},
"replay_errors": {
"description": "Total number of packets dropped due to replay check on that Security association (SA).",
"readonly": true,
"title": "Replay errors",
"type": "integer"
},
"sa_mismatch_errors_in": {
"description": "Totoal number of security association (SA) mismatch errors on incoming packets.",
"readonly": true,
"title": "Security association (SA) mismatch errors on incoming packets",
"type": "integer"
},
"sa_mismatch_errors_out": {
"description": "Totoal number of security association (SA) mismatch errors on outgoing packets.",
"readonly": true,
"title": "Security association (SA) mismatch errors on outgoing packets",
"type": "integer"
},
"seq_number_overflow_error": {
"description": "Total number of packets dropped while sending due to overflow in sequence number.",
"readonly": true,
"title": "Sequence number overflow error",
"type": "integer"
},
"tunnel_down_reason": {
"description": "Gives the detailed reason about the tunnel when it is down. If tunnel is UP tunnel down reason will be empty.",
"readonly": true,
"title": "Tunnel down reason",
"type": "string"
},
"tunnel_status": {
"description": "Specifies the status of tunnel. If all the SA (Security association) are negotiated then tunnels status will be UP. If negotiation fails for the SAs status will be DOWN, if SAs are in negotiating phase tunnels status will be NEGOTIATING.",
"enum": [
"UP",
"DOWN",
"NEGOTIATING"
],
"readonly": true,
"title": "Tunnel Status",
"type": "string"
}
},
"title": "IPSec VPN tunnel traffic statistics",
"type": "object"
}
IPSubnet (type)
{
"additionalProperties": false,
"id": "IPSubnet",
"properties": {
"ip_addresses": {
"items": {
"$ref": "IPv4Address
},
"maxItems": 1,
"minItems": 1,
"required": true,
"title": "IPv4 Addresses",
"type": "array"
},
"prefix_length": {
"maximum": 32,
"minimum": 1,
"required": true,
"title": "Subnet Prefix Length",
"type": "integer"
}
},
"type": "object"
}
IPv4Address (type)
{
"id": "IPv4Address",
"maxLength": 255,
"pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$",
"title": "IPv4 address",
"type": "string"
}
IPv4AddressProperties (type)
{
"additionalProperties": false,
"id": "IPv4AddressProperties",
"properties": {
"ip_address": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$",
"title": "Interface IPv4 address",
"type": "string"
},
"netmask": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$",
"title": "Interface netmask",
"type": "string"
}
},
"title": "IPv4 address properties",
"type": "object"
}
IPv4CIDRBlock (type)
{
"id": "IPv4CIDRBlock",
"maxLength": 255,
"pattern": "^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\\/(3[0-2]|[1-2][0-9]|[0-9]))$",
"title": "IPv4 CIDR Block",
"type": "string"
}
IPv6AddressProperties (type)
{
"additionalProperties": false,
"id": "IPv6AddressProperties",
"properties": {
"ip6_address": {
"pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$",
"title": "Interface IPv6 address",
"type": "string"
},
"ip6_gateway": {
"pattern": "^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$",
"title": "IPv6 Gateway",
"type": "string"
},
"prefixlen": {
"title": "Prefix length",
"type": "integer"
}
},
"title": "IPv6 address properties",
"type": "object"
}
IncludedFieldsParameters (type)
{
"additionalProperties": false,
"id": "IncludedFieldsParameters",
"properties": {
"included_fields": {
"title": "Comma separated list of fields that should be included in query result",
"type": "string"
}
},
"title": "A list of fields to include in query results",
"type": "object"
}
Interface (type)
{
"additionalProperties": false,
"description": "Interface properties.",
"id": "Interface",
"properties": {
"address": {
"$ref": "IPCIDRBlock,
"description": "IPv4 or IPv6 CIDR block.",
"required": true,
"title": "CIDR block",
"type": "string"
},
"interface_type": {
"description": "Interface type.",
"enum": [
"MANAGEMENT",
"TUNNEL"
],
"required": true,
"title": "Interface type",
"type": "string"
},
"name": {
"description": "Interface name.",
"required": true,
"title": "Interface name",
"type": "string"
}
},
"title": "Interface properties",
"type": "object"
}
KnownHostParameter (type)
{
"additionalProperties": false,
"id": "KnownHostParameter",
"properties": {
"host": {
"$ref": "HostnameOrIPv46Address,
"required": true,
"title": "Known host hostname or IPv4/v6 address"
},
"port": {
"default": 22,
"maximum": 65535,
"minimum": 1,
"title": "Known host port",
"type": "integer"
}
},
"type": "object"
}
L2Extension (type)
{
"description": "Configuration for extending L2 domain with L2VPN.",
"id": "L2Extension",
"properties": {
"l2vpn_session_id": {
"description": "L2VPN sessions identifier for L2 extension.",
"required": true,
"title": "L2VPN session ID",
"type": "string"
},
"l2vpn_session_name": {
"description": "Display name of the given l2vpn session.",
"readOnly": true,
"required": false,
"title": "Display name of the given l2vpn session",
"type": "string"
},
"tunnel_id": {
"description": "Tunnel ID to uniquely identify the L2 extension.",
"maximum": 4093,
"minimum": 1,
"required": true,
"title": "Tunnel ID",
"type": "integer"
}
},
"title": "L2 Extension",
"type": "object"
}
L2VPNSession (type)
{
"additionalProperties": false,
"description": "L2VPN Session represents meta data necessary to create the L2VPN Session. For client, it is represented by an array of peer code for each transport tunnel.",
"extends": {
"$ref": "ManagedResource
},
"id": "L2VPNSession",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"enabled": {
"default": true,
"description": "Enable to extend all the associated logical switches.",
"required": false,
"title": "Enable L2VPN session",
"type": "boolean"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"transport_tunnels": {
"description": "List of L2VPN transport tunnel.",
"items": {
"$ref": "TransportTunnel
},
"maxItems": 4,
"minItems": 1,
"required": true,
"title": "List of L2VPN Transport Tunnel",
"type": "array"
}
},
"title": "L2VPN Session",
"type": "object"
}
L2VPNSessionListResult (type)
{
"additionalProperties": false,
"description": "list all the L2VPN sessions",
"extends": {
"$ref": "ListResult
},
"id": "L2VPNSessionListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "L2VPNSession
},
"required": true,
"title": "L2VPN sessions list result",
"type": "array"
}
},
"title": "List all L2VPN sessions",
"type": "object"
}
L2VPNSessionStatistics (type)
{
"description": "L2VPN session statistics.",
"id": "L2VPNSessionStatistics",
"properties": {
"display_name": {
"description": "Display name of L2VPN session.",
"readonly": true,
"title": "Display name",
"type": "string"
},
"l2vpn_session_id": {
"description": "UUID of L2VPN session.",
"readonly": true,
"title": "Session identifier",
"type": "string"
},
"reference_count": {
"description": "Number of logical ports that are referencing the L2VPN session.",
"readonly": true,
"title": "Number of references to L2VPN session",
"type": "integer"
},
"session_status": {
"description": "L2VPN session status. It can be UP and DOWN.",
"enum": [
"UP",
"DOWN"
],
"readonly": true,
"title": "L2VPN session status",
"type": "string"
},
"traffic_counter": {
"$ref": "L2VPNTrafficStatistics,
"description": "Traffic counter through the L2VPN session.",
"readonly": true,
"title": "Traffic counter"
},
"transport_tunnels": {
"description": "List of transport tunnels.",
"items": {
"$ref": "TransportTunnel
},
"readonly": true,
"title": "List of transport tunnels",
"type": "array"
}
},
"title": "L2VPN session statistics",
"type": "object"
}
L2VPNTrafficStatistics (type)
{
"additionalProperties": false,
"description": "Traffic statistics for L2VPN.",
"id": "L2VPNTrafficStatistics",
"properties": {
"bytes_in": {
"description": "Total number of incoming bytes.",
"readonly": true,
"title": "Bytes in",
"type": "integer"
},
"bytes_out": {
"description": "Total number of outgoing bytes.",
"readonly": true,
"title": "Bytes out",
"type": "integer"
},
"dropped_packets_in": {
"description": "Total number of incoming packets dropped.",
"readonly": true,
"title": "Dropped incoming packets",
"type": "integer"
},
"dropped_packets_out": {
"description": "Total number of outgoing packets dropped.",
"readonly": true,
"title": "Dropped outgoing packets",
"type": "integer"
},
"packets_in": {
"description": "Total number of incoming packets.",
"readonly": true,
"title": "Packets in",
"type": "integer"
},
"packets_out": {
"description": "Total number of outgoing packets.",
"readonly": true,
"title": "Packets out",
"type": "integer"
}
},
"title": "L2VPN traffic statistics",
"type": "object"
}
ListCertParameter (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListRequestParameters
},
"id": "ListCertParameter",
"properties": {
"cursor": {
"readonly": false,
"title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"type": "string"
},
"details": {
"default": false,
"required": false,
"title": "whether to expand the pem data and show all its details",
"type": "boolean"
},
"included_fields": {
"title": "Comma separated list of fields that should be included in query result",
"type": "string"
},
"page_size": {
"default": 1000,
"maximum": 1000,
"minimum": 0,
"title": "Maximum number of results to return in this page (server may return fewer)",
"type": "integer"
},
"sort_ascending": {
"type": "boolean"
},
"sort_by": {
"title": "Field by which records are sorted",
"type": "string"
},
"type": {
"description": "Provide this parameter to limit the list of returned certificates to those matching a particular usage. Passing cluster_certificate will return the certificate used for the cluster wide API service.",
"enum": [
"cluster_api_certificate"
],
"required": false,
"title": "Type of certificate to return",
"type": "string"
}
},
"type": "object"
}
ListRequestParameters (type)
{
"additionalProperties": {},
"extends": {
"$ref": "IncludedFieldsParameters
},
"id": "ListRequestParameters",
"properties": {
"cursor": {
"readonly": false,
"title": "Opaque cursor to be used for getting next page of records (supplied by current result page)",
"type": "string"
},
"included_fields": {
"title": "Comma separated list of fields that should be included in query result",
"type": "string"
},
"page_size": {
"default": 1000,
"maximum": 1000,
"minimum": 0,
"title": "Maximum number of results to return in this page (server may return fewer)",
"type": "integer"
},
"sort_ascending": {
"type": "boolean"
},
"sort_by": {
"title": "Field by which records are sorted",
"type": "string"
}
},
"type": "object"
}
ListResult (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "ListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "Resource
},
"required": true,
"title": "Result list",
"type": "array"
}
},
"type": "object"
}
ListResultQueryParameters (type)
{
"id": "ListResultQueryParameters",
"properties": {
"fields": {
"description": "Comma-separated field names to include in query result",
"title": "Fields to include in query results",
"type": "string"
}
},
"type": "object"
}
LogicalPort (type)
{
"abstract": true,
"extends": {
"$ref": "ManagedResource
},
"id": "LogicalPort",
"polymorphic-type-descriptor": {
"mode": "enabled"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"$ref": "LogicalPortResourceType,
"required": true
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}
LogicalPortListParameters (type)
{
"additionalProperties": false,
"description": "Parameters to get filtered list of logical ports. The filter parameters are mutually exclusive.",
"id": "LogicalPortListParameters",
"properties": {
"l2_extension_id": {
"description": "List all of the logical ports that are extended via the specified l2vpn session id.",
"title": "Id of a specified l2vpn session",
"type": "string"
},
"port_type": {
"description": "If routed, list all of the routed logical ports. If extended, list all of the extended logial ports. If none, list all pure l2 logical ports (not routed and extended).",
"enum": [
"routed",
"extended",
"none"
],
"required": false,
"title": "Type of logical port",
"type": "string"
}
},
"title": "List parameters for logical port",
"type": "object"
}
LogicalPortListResult (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListResult
},
"id": "LogicalPortListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "LogicalPort
},
"required": true,
"title": "Logical port list results",
"type": "array"
}
},
"type": "object"
}
LogicalPortResourceType (type)
{
"additionalProperties": false,
"description": "LogicalRouterPort is the L3 Port attached to the router. LogicalRouterIPTunnelPort is a IPSec VPN tunnel port created on logical router when route based VPN session configured. LogicalRouterLoopbackPort is a loopback port for the logical router. LogicalRouterManagementPort is a management port on the logical router.",
"enum": [
"LogicalRouterPort",
"LogicalRouterIPTunnelPort",
"LogicalRouterLoopbackPort",
"LogicalRouterManagementPort"
],
"id": "LogicalPortResourceType",
"title": "Resource types of logical port",
"type": "string"
}
LogicalRouterHaHistory (type)
{
"id": "LogicalRouterHaHistory",
"properties": {
"event": {
"description": "Logical router HA event that triggered state change",
"readonly": true,
"title": "Logical router HA event that triggered state change",
"type": "string"
},
"event_timestamp": {
"$ref": "EpochMsTimestamp,
"description": "Time in UTC when the last HA event occured",
"readonly": true,
"title": "Time in UTC when the last HA event occured"
},
"state": {
"description": "Logical router HA state DOWN - Logical router is not in good health SYNC - Logical router is synchronizing data from peer logical router STANDBY - Logical router is available to go Active ACTIVE - Logical router is forwarding traffic",
"enum": [
"DOWN",
"SYNC",
"STANDBY",
"ACTIVE"
],
"readonly": true,
"title": "Logical router HA state",
"type": "string"
}
},
"type": "object"
}
LogicalRouterIPTunnelPort (type)
{
"additionalProperties": false,
"description": "Logical router IP tunnel port.",
"extends": {
"$ref": "LogicalPort
},
"id": "LogicalRouterIPTunnelPort",
"polymorphic-type-descriptor": {
"type-identifier": "LogicalRouterIPTunnelPort"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"admin_state": {
"description": "Admin state of port.",
"enum": [
"UP",
"DOWN"
],
"readonly": true,
"title": "Admin state of port",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"$ref": "LogicalPortResourceType,
"required": true
},
"subnets": {
"description": "Tunnel port subnets.",
"items": {
"$ref": "IPSubnet
},
"maxItems": 1,
"minItems": 1,
"readonly": true,
"required": true,
"title": "Tunnel port subnets",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"vpn_session_id": {
"description": "Associated VPN session identifier.",
"readonly": true,
"title": "VPN session identifier",
"type": "string"
}
},
"title": "Logical router IP tunnel port",
"type": "object"
}
LogicalRouterLoopbackPort (type)
{
"additionalProperties": false,
"extends": {
"$ref": "LogicalPort
},
"id": "LogicalRouterLoopbackPort",
"polymorphic-type-descriptor": {
"type-identifier": "LogicalRouterLoopbackPort"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"$ref": "LogicalPortResourceType,
"required": true
},
"subnets": {
"items": {
"$ref": "IPSubnet
},
"maxItems": 1,
"required": false,
"title": "Logical router loopback port subnets",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}
LogicalRouterPort (type)
{
"additionalProperties": false,
"extends": {
"$ref": "LogicalPort
},
"id": "LogicalRouterPort",
"polymorphic-type-descriptor": {
"type-identifier": "LogicalRouterPort"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"dhcp_server_id": {
"description": "Specify DHCP server for L2 domain to use. If not given, there is no DHCP service in the L2 domain.",
"required": false,
"title": "DHCP server ID",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"exit_interface": {
"$ref": "ExitEdgeInterface,
"description": "Exit interface from edge",
"readonly": false,
"required": true,
"title": "Exit interface from edge"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"l2_extensions": {
"description": "Configuration for extending L2 domain via L2VPN.",
"items": {
"$ref": "L2Extension
},
"minItems": 1,
"required": false,
"title": "L2 extensions",
"type": "array"
},
"mac_address": {
"description": "MAC address",
"readonly": true,
"required": false,
"title": "MAC address",
"type": "string"
},
"mtu": {
"default": 1500,
"description": "Maximum transmission unit specifies the size of the largest packet that a network protocol can transmit.",
"maximum": 9000,
"minimum": 64,
"title": "Maximum transmission unit (MTU)",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"$ref": "LogicalPortResourceType,
"required": true
},
"subnets": {
"items": {
"$ref": "IPSubnet
},
"maxItems": 1,
"required": false,
"title": "Logical router port subnets",
"type": "array"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"urpf_mode": {
"$ref": "UrpfMode,
"default": "STRICT",
"required": false,
"title": "Unicast Reverse Path Forwarding mode"
},
"vlan_id": {
"maximum": 4091,
"minimum": 0,
"required": true,
"title": "VLAN for the Logical Switch",
"type": "integer"
}
},
"type": "object"
}
LogicalRouterPortCounters (type)
{
"additionalProperties": false,
"id": "LogicalRouterPortCounters",
"properties": {
"dropped_packets": {
"required": true,
"title": "Number of Dropped Packets",
"type": "integer"
},
"total_bytes": {
"required": true,
"title": "Total Number of Bytes",
"type": "integer"
},
"total_packets": {
"required": true,
"title": "Total Number of Packets",
"type": "integer"
}
},
"type": "object"
}
LogicalRouterPortStatistics (type)
{
"additionalProperties": false,
"id": "LogicalRouterPortStatistics",
"properties": {
"admin_state": {
"description": "Configurable administrative state.",
"enum": [
"UP",
"DOWN"
],
"required": true,
"title": "Administrative State",
"type": "string"
},
"last_update_timestamp": {
"required": true,
"title": "Timestamp in Milliseconds Since Epoch",
"type": "integer"
},
"logical_router_port_id": {
"required": true,
"title": "Logical Router Port UUID",
"type": "string"
},
"operational_state": {
"description": "Operational state of the port. Takes into account the exit interface status.",
"enum": [
"UP",
"DOWN"
],
"required": true,
"title": "Operational State",
"type": "string"
},
"rx": {
"$ref": "LogicalRouterPortCounters,
"required": true,
"title": "Logical Router Port Receive Count",
"type": "object"
},
"tx": {
"$ref": "LogicalRouterPortCounters,
"required": true,
"title": "Logical Router Port Transmit Count",
"type": "object"
}
},
"type": "object"
}
LogicalRouterRouteEntry (type)
{
"additionalProperties": false,
"id": "LogicalRouterRouteEntry",
"properties": {
"admin_distance": {
"required": true,
"title": "Admin Distance",
"type": "integer"
},
"logical_router_port_id": {
"required": true,
"title": "Logical Router Port ID",
"type": "string"
},
"network": {
"$ref": "IPv4CIDRBlock,
"required": true,
"title": "Network"
},
"next_hop": {
"$ref": "IPv4Address,
"required": false,
"title": "Next Hop"
},
"route_type": {
"$ref": "RouteType,
"required": true,
"title": "Route Type"
}
},
"type": "object"
}
LogicalRouterRouteTable (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListResult
},
"id": "LogicalRouterRouteTable",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"last_update_timestamp": {
"readonly": true,
"required": true,
"title": "Timestamp in Milliseconds Since Epoch",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "LogicalRouterRouteEntry
},
"required": true,
"title": "Logical Router Route Entry",
"type": "array"
}
},
"type": "object"
}
LogicalRouterType (type)
{
"extends": {
"$ref": "ListResultQueryParameters
},
"id": "LogicalRouterType",
"properties": {
"fields": {
"description": "Comma-separated field names to include in query result",
"title": "Fields to include in query results",
"type": "string"
},
"router_type": {
"description": "Logical router type",
"enum": [
"SERVICE_ROUTER_TIER0",
"VRF_SERVICE_ROUTER_TIER0",
"DISTRIBUTED_ROUTER_TIER0",
"VRF_DISTRIBUTED_ROUTER_TIER0",
"SERVICE_ROUTER_TIER1",
"VRF_SERVICE_ROUTER_TIER1",
"DISTRIBUTED_ROUTER_TIER1",
"VRF_DISTRIBUTED_ROUTER_TIER1",
"TUNNEL",
"RTEP_TUNNEL_VRF"
],
"title": "Logical router type",
"type": "string"
}
},
"type": "object"
}
LogicalRoutersInfo (type)
{
"id": "LogicalRoutersInfo",
"properties": {
"ha_info": {
"$ref": "HaInfo,
"description": "Logical router high-availability information",
"readonly": true,
"title": "Logical router high-availability information"
},
"logical_router_uuid": {
"description": "Logical router UUID",
"readonly": true,
"title": "Logical router UUID",
"type": "string"
},
"mp_router_uuid": {
"description": "MP logical router UUID",
"readonly": true,
"title": "MP logical router UUID",
"type": "string"
},
"name": {
"description": "Name of the logical router",
"readonly": true,
"title": "Name of the logical router",
"type": "string"
},
"router_type": {
"description": "Logical router type",
"enum": [
"SERVICE_ROUTER_TIER0",
"VRF_SERVICE_ROUTER_TIER0",
"DISTRIBUTED_ROUTER_TIER0",
"VRF_DISTRIBUTED_ROUTER_TIER0",
"SERVICE_ROUTER_TIER1",
"VRF_SERVICE_ROUTER_TIER1",
"DISTRIBUTED_ROUTER_TIER1",
"VRF_DISTRIBUTED_ROUTER_TIER1",
"TUNNEL",
"RTEP_TUNNEL_VRF"
],
"readonly": true,
"title": "Logical router type",
"type": "string"
}
},
"type": "object"
}
MaintenanceModePropertiesReply (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "MaintenanceModePropertiesReply",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"maintenance_mode": {
"default": "disabled",
"description": "current maintenance mode",
"enum": [
"enabled",
"disabled"
],
"readonly": true,
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Information about the Edge maintenance mode",
"type": "object"
}
MaintenanceModePropertiesRequest (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "MaintenanceModePropertiesRequest",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"maintenance_mode": {
"description": "current maintenance mode",
"readonly": false,
"type": "boolean"
},
"notify_mpa": {
"default": true,
"description": "send notification to MPA",
"readonly": false,
"type": "boolean"
}
},
"title": "Information about the Edge maintenance mode",
"type": "object"
}
ManagedResource (type)
{
"abstract": true,
"extends": {
"$ref": "RevisionedResource
},
"id": "ManagedResource",
"polymorphic-type-descriptor": {
"property-name": "resource_type"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"title": "Base type for resources that are managed by API clients",
"type": "object"
}
MandatoryAccessControlProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "MandatoryAccessControlProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"enabled": {
"description": "Enabled can be True/False",
"type": "boolean"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"status": {
"description": "current status of Mandatory Access Control",
"enum": [
"ENABLED",
"DISABLED",
"ENABLED_PENDING_REBOOT"
],
"readonly": true,
"type": "string"
}
},
"title": "Information about mandatory access control",
"type": "object"
}
NAPILogLevelValue (type)
{
"additionalProperties": false,
"id": "NAPILogLevelValue",
"properties": {
"log_level": {
"enum": [
"critical",
"error",
"warn",
"info",
"debug",
"off"
],
"required": true,
"title": "Log Level",
"type": "string"
}
},
"title": "Log Level Value",
"type": "object"
}
NodeAdminState (type)
{
"enum": [
"UP",
"DOWN",
"UNKNOWN"
],
"id": "NodeAdminState",
"title": "Node Admin State",
"type": "string"
}
NodeFileSystemProperties (type)
{
"additionalProperties": false,
"id": "NodeFileSystemProperties",
"properties": {
"file_system": {
"readonly": true,
"title": "File system id",
"type": "string"
},
"mount": {
"readonly": true,
"title": "File system mount",
"type": "string"
},
"total": {
"readonly": true,
"title": "File system size in kilobytes",
"type": "integer"
},
"type": {
"readonly": true,
"title": "File system type",
"type": "string"
},
"used": {
"readonly": true,
"title": "Amount of file system used in kilobytes",
"type": "integer"
}
},
"title": "File system properties",
"type": "object"
}
NodeGrubProperties (type)
{
"additionalProperties": false,
"id": "NodeGrubProperties",
"properties": {
"timeout": {
"maximum": 2147483647,
"minimum": 0,
"title": "GRUB menu timeout value in seconds",
"type": "integer"
},
"users": {
"items": {
"$ref": "NodeGrubUserProperties
},
"title": "List of node GRUB user properties",
"type": "array"
}
},
"title": "Node GRUB properties",
"type": "object"
}
NodeGrubUserProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeGrubUserProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"password": {
"sensitive": true,
"title": "Password for the GRUB user",
"type": "string"
},
"username": {
"title": "Username of the GRUB user",
"type": "string"
}
},
"title": "Node GRUB user properties",
"type": "object"
}
NodeHAStatus (type)
{
"enum": [
"ACTIVE",
"INACTIVE",
"STATE_SYNC",
"DISCOVER",
"OFFLINE",
"DISABLED",
"UNKNOWN"
],
"id": "NodeHAStatus",
"title": "Node High Availability Status",
"type": "string"
}
NodeIdServicesMap (type)
{
"additionalProperties": false,
"id": "NodeIdServicesMap",
"properties": {
"node_id": {
"maxLength": 255,
"readonly": false,
"required": true,
"title": "NodeId",
"type": "string"
},
"service_types": {
"description": "list of ServiceTypes",
"items": {
"$ref": "ServiceType
},
"readonly": false,
"required": true,
"type": "array"
}
},
"type": "object"
}
NodeInterfaceStatisticsProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeInterfaceStatisticsProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"interface_id": {
"readonly": true,
"title": "Interface ID",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"rx_bytes": {
"readonly": true,
"title": "Number of bytes received",
"type": "integer"
},
"rx_dropped": {
"readonly": true,
"title": "Number of packets dropped",
"type": "integer"
},
"rx_errors": {
"readonly": true,
"title": "Number of receive errors",
"type": "integer"
},
"rx_frame": {
"readonly": true,
"title": "Number of framing errors",
"type": "integer"
},
"rx_packets": {
"readonly": true,
"title": "Number of packets received",
"type": "integer"
},
"tx_bytes": {
"readonly": true,
"title": "Number of bytes transmitted",
"type": "integer"
},
"tx_carrier": {
"readonly": true,
"title": "Number of carrier losses detected",
"type": "integer"
},
"tx_colls": {
"readonly": true,
"title": "Number of collisions detected",
"type": "integer"
},
"tx_dropped": {
"readonly": true,
"title": "Number of packets dropped",
"type": "integer"
},
"tx_errors": {
"readonly": true,
"title": "Number of transmit errors",
"type": "integer"
},
"tx_packets": {
"readonly": true,
"title": "Number of packets transmitted",
"type": "integer"
}
},
"title": "Node network interface statistic properties",
"type": "object"
}
NodeLogProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeLogProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"last_modified_time": {
"$ref": "EpochMsTimestamp,
"readonly": true,
"title": "Last modified time expressed in milliseconds since epoch"
},
"log_name": {
"readonly": true,
"title": "Name of log file",
"type": "string"
},
"log_size": {
"readonly": true,
"title": "Size of log file in bytes",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Node log properties",
"type": "object"
}
NodeLogPropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "NodeLogPropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "NodeLogProperties
},
"required": true,
"title": "Node log property results",
"type": "array"
}
},
"title": "Node log property query results",
"type": "object"
}
NodeMotdProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeMotdProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"motd": {
"title": "Message of the day to display when users login to node using the NSX CLI",
"type": [
"string",
"null"
]
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Node message of the day properties",
"type": "object"
}
NodeNameServersProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeNameServersProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"name_servers": {
"items": {
"type": "string"
},
"maxItems": 3,
"required": true,
"title": "Name servers",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Node network name servers properties",
"type": "object"
}
NodeNetworkInterfaceProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeNetworkInterfaceProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"admin_status": {
"enum": [
"up",
"down"
],
"readonly": true,
"title": "Interface administration status",
"type": "string"
},
"bond_cur_active_slave": {
"readonly": true,
"title": "Bond's currently active slave device",
"type": "string"
},
"bond_lacp_rate": {
"readonly": true,
"title": "Bond's rate at which we'll ask our link partner to transmit LACPDU packets in 802.3ad mode",
"type": "string"
},
"bond_mode": {
"enum": [
"ACTIVE_BACKUP",
"802_3AD",
"ROUND_ROBIN",
"BROADCAST",
"XOR",
"TLB",
"ALB"
],
"title": "Bond mode",
"type": "string"
},
"bond_primary": {
"title": "Bond's primary device name in active-backup bond mode",
"type": "string"
},
"bond_primary_slave": {
"readonly": true,
"title": "Bond's primary device name in active-backup bond mode",
"type": "string"
},
"bond_slaves": {
"items": {
"type": "string"
},
"title": "Bond's slave devices",
"type": "array"
},
"bond_xmit_hash_policy": {
"enum": [
"layer2",
"layer2+3",
"layer3+4",
"encap2+3",
"encap3+4"
],
"readonly": true,
"title": "Bond's transmit hash policy for balance-xor and 802.3ad modes",
"type": "string"
},
"broadcast_address": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$",
"title": "Interface broadcast address",
"type": "string"
},
"default_gateway": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$",
"title": "Interface's default gateway",
"type": "string"
},
"interface_id": {
"readonly": true,
"required": true,
"title": "Interface ID",
"type": "string"
},
"ip6_addresses": {
"items": {
"$ref": "IPv6AddressProperties
},
"title": "Interface IPv6 addresses",
"type": "array"
},
"ip_addresses": {
"items": {
"$ref": "IPv4AddressProperties
},
"maxItems": 1,
"title": "Interface IP addresses",
"type": "array"
},
"ip_configuration": {
"enum": [
"dhcp",
"static",
"not configured"
],
"required": true,
"title": "Interface configuration",
"type": "string"
},
"is_kni": {
"readonly": true,
"title": "Interface is a KNI",
"type": "boolean"
},
"link_status": {
"enum": [
"up",
"down"
],
"readonly": true,
"title": "Interface administration status",
"type": "string"
},
"mtu": {
"title": "Interface MTU",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"physical_address": {
"pattern": "^[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}:[0-9A-Fa-f]{2}$",
"readonly": true,
"title": "Interface MAC address",
"type": "string"
},
"plane": {
"enum": [
"mgmt",
"debug",
"none"
],
"title": "Interface plane",
"type": "string"
},
"vlan": {
"maximum": 4094,
"minimum": 1,
"readonly": true,
"title": "VLAN Id",
"type": "integer"
}
},
"title": "Node network interface properties",
"type": "object"
}
NodeNetworkInterfacePropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "NodeNetworkInterfacePropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "NodeNetworkInterfaceProperties
},
"required": true,
"title": "Node network interface property results",
"type": "array"
}
},
"title": "Node network interface properties list results",
"type": "object"
}
NodeNetworkProperties (type)
{
"extends": {
"$ref": "Resource
},
"id": "NodeNetworkProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "Network configuration properties",
"type": "object"
}
NodeNtpServiceProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "NodeServiceProperties
},
"id": "NodeNtpServiceProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"service_name": {
"required": true,
"title": "Service name",
"type": "string"
},
"service_properties": {
"$ref": "NtpServiceProperties,
"title": "NTP Service properties"
}
},
"title": "Node NTP service properties",
"type": "object"
}
NodeProcessProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeProcessProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"cpu_time": {
"readonly": true,
"title": "CPU time (user and system) consumed by process in milliseconds",
"type": "integer"
},
"mem_resident": {
"readonly": true,
"title": "Resident set size of process in bytes",
"type": "integer"
},
"mem_used": {
"readonly": true,
"title": "Virtual memory used by process in bytes",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"pid": {
"readonly": true,
"title": "Process id",
"type": "integer"
},
"ppid": {
"readonly": true,
"title": "Parent process id",
"type": "integer"
},
"process_name": {
"readonly": true,
"title": "Process name",
"type": "string"
},
"start_time": {
"$ref": "EpochMsTimestamp,
"readonly": true,
"title": "Process start time expressed in milliseconds since epoch"
},
"uptime": {
"readonly": true,
"title": "Milliseconds since process started",
"type": "integer"
}
},
"title": "Node process properties",
"type": "object"
}
NodeProcessPropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "NodeProcessPropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "NodeProcessProperties
},
"required": true,
"title": "Node process property results",
"type": "array"
}
},
"title": "Node process property query results",
"type": "object"
}
NodeProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"cli_coredump_config": {
"$ref": "CoreDumpConfig,
"readonly": true,
"title": "NSX CLI core dump files config"
},
"cli_history_size": {
"minimum": 0,
"title": "NSX CLI command history limit, set to 0 to configure no history size limit",
"type": "integer"
},
"cli_output_datetime": {
"title": "NSX CLI display datetime stamp in command output",
"type": "boolean"
},
"cli_timeout": {
"minimum": 0,
"title": "NSX CLI inactivity timeout, set to 0 to configure no timeout",
"type": "integer"
},
"export_type": {
"enum": [
"RESTRICTED",
"UNRESTRICTED"
],
"readonly": true,
"title": "Export restrictions in effect, if any",
"type": "string"
},
"fully_qualified_domain_name": {
"readonly": true,
"title": "Fully qualified domain name",
"type": "string"
},
"hostname": {
"$ref": "SystemHostname,
"title": "Host name or fully qualified domain name of node",
"type": "string"
},
"kernel_version": {
"readonly": true,
"title": "Kernel version",
"type": "string"
},
"motd": {
"title": "Message of the day to display when users login to node using the NSX CLI",
"type": [
"string",
"null"
]
},
"node_type": {
"enum": [
"NSX Manager",
"NSX Global Manager",
"NSX Edge",
"NSX Autonomous Edge",
"NSX Cloud Service Manager",
"NSX Public Cloud Gateway",
"NSX Malware Prevention Service VM"
],
"readonly": true,
"title": "Node type",
"type": "string"
},
"node_uuid": {
"maxLength": 36,
"readonly": true,
"title": "Node Unique Identifier",
"type": "string"
},
"node_version": {
"readonly": true,
"title": "Node version",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"product_version": {
"readonly": true,
"title": "Product version",
"type": "string"
},
"system_datetime": {
"$ref": "DatetimeUTC,
"title": "System date time in UTC"
},
"system_time": {
"$ref": "EpochMsTimestamp,
"readonly": true,
"title": "Current time expressed in milliseconds since epoch"
},
"timezone": {
"title": "Timezone",
"type": "string"
}
},
"title": "Node properties",
"type": "object"
}
NodeRouteProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeRouteProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"destination": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$",
"title": "Destination covered by route",
"type": "string"
},
"from_address": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$",
"title": "From address",
"type": "string"
},
"gateway": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$",
"title": "Address of next hop",
"type": "string"
},
"interface_id": {
"title": "Network interface id of route",
"type": "string"
},
"ipv6": {
"title": "IPv6 flag",
"type": "boolean"
},
"metric": {
"description": "Default metric value for IPv4 is 0, whereas for IPv6 default value is 1024",
"title": "Metric value of route",
"type": "string"
},
"netmask": {
"description": "For IPv4 this field expects valid IPv4 netmask address, whereas in case of IPv6 it expects valid prefix length",
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$|^[\\d]{1,3}$",
"title": "Netmask or prefix length of destination covered by route",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"proto": {
"default": "boot",
"enum": [
"unspec",
"redirect",
"kernel",
"boot",
"static",
"gated",
"ra",
"mrt",
"zebra",
"bird",
"dnrouted",
"xorp",
"ntk",
"dhcp"
],
"title": "Routing protocol identifier of route",
"type": "string"
},
"route_id": {
"readonly": true,
"title": "Unique identifier for the route",
"type": "string"
},
"route_type": {
"enum": [
"default",
"static",
"blackhole",
"prohibit",
"throw",
"unreachable"
],
"required": true,
"title": "Route type",
"type": "string"
},
"scope": {
"title": "Scope of destinations covered by route",
"type": "string"
},
"src": {
"pattern": "^[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}\\.[\\d]{1,3}$|^(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\\\\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9]))$",
"title": "Source address to prefer when sending to destinations of route",
"type": "string"
}
},
"title": "Node network route properties",
"type": "object"
}
NodeRoutePropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "NodeRoutePropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "NodeRouteProperties
},
"required": true,
"title": "Node route property results",
"type": "array"
}
},
"title": "Node network route properties list results",
"type": "object"
}
NodeSearchDomainsProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeSearchDomainsProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"search_domains": {
"items": {
"type": "string"
},
"required": true,
"title": "Search domains",
"type": "array"
}
},
"title": "Node network search domains properties",
"type": "object"
}
NodeServiceProperties (type)
{
"extends": {
"$ref": "Resource
},
"id": "NodeServiceProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"service_name": {
"required": true,
"title": "Service name",
"type": "string"
}
},
"title": "Node service properties",
"type": "object"
}
NodeServicePropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "NodeServicePropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "NodeServiceProperties
},
"required": true,
"title": "Node service property results",
"type": "array"
}
},
"title": "Node service property query results",
"type": "object"
}
NodeServiceStatusProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeServiceStatusProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"health": {
"enum": [
"STABLE",
"DEGRADED"
],
"readonly": true,
"required": false,
"title": "Service health in addition to runtime_state",
"type": "string"
},
"monitor_pid": {
"readonly": true,
"title": "Service monitor process id",
"type": "integer"
},
"monitor_runtime_state": {
"enum": [
"running",
"stopped"
],
"readonly": true,
"title": "Service monitor runtime state",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"pids": {
"items": {
"type": "integer"
},
"readonly": true,
"title": "Service process ids",
"type": "array"
},
"reason": {
"readonly": true,
"required": false,
"title": "Reason for service degradation",
"type": "string"
},
"runtime_state": {
"enum": [
"running",
"stopped"
],
"readonly": true,
"title": "Service runtime state",
"type": "string"
}
},
"title": "Node service status properties",
"type": "object"
}
NodeSnmpServiceProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "NodeServiceProperties
},
"id": "NodeSnmpServiceProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"service_name": {
"required": true,
"title": "Service name",
"type": "string"
},
"service_properties": {
"$ref": "SnmpServiceProperties,
"required": true,
"title": "SNMP Service properties"
}
},
"title": "Node SNMP service properties",
"type": "object"
}
NodeSnmpV3EngineID (type)
{
"additionalProperties": false,
"extends": {
"$ref": "NodeServiceProperties
},
"id": "NodeSnmpV3EngineID",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"service_name": {
"required": true,
"title": "Service name",
"type": "string"
},
"v3_engine_id": {
"required": true,
"title": "SNMP v3 engine id",
"type": "string"
}
},
"title": "SNMP V3 Engine Id",
"type": "object"
}
NodeSshServiceProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "NodeServiceProperties
},
"id": "NodeSshServiceProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"service_name": {
"required": true,
"title": "Service name",
"type": "string"
},
"service_properties": {
"$ref": "SshServiceProperties,
"title": "SSH Service properties"
}
},
"title": "Node SSH service properties",
"type": "object"
}
NodeStatus (type)
{
"enum": [
"DOWN",
"UP",
"UNREACHABLE",
"ADMIN_DOWN",
"UP_ROUTING_DOWN",
"INVALID",
"UNKNOWN"
],
"id": "NodeStatus",
"title": "Node Status",
"type": "string"
}
NodeStatusProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeStatusProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"bootup_error": {
"readonly": true,
"title": "Autonomous edge bootup error",
"type": "string"
},
"cpu_cores": {
"readonly": true,
"title": "Number of CPU cores on the system",
"type": "integer"
},
"file_systems": {
"items": {
"$ref": "NodeFileSystemProperties
},
"readonly": true,
"title": "File systems configured on the system",
"type": "array"
},
"load_average": {
"items": {
"type": "number"
},
"readonly": true,
"title": "One, five, and fifteen minute load averages for the system",
"type": "array"
},
"mem_available": {
"readonly": true,
"title": "Amount of available RAM in the system, in kilobytes. The amount of reclaimable buffer/cache memory in use is taken into consideration here to provide a better idea of how much memory is really available in the system",
"type": "integer"
},
"mem_buffer": {
"readonly": true,
"title": "Amount of RAM on the system used for temporary disk block storage, in kilobytes",
"type": "integer"
},
"mem_cache": {
"readonly": true,
"title": "Amount of RAM on the system that can be flushed out to disk, in kilobytes",
"type": "integer"
},
"mem_free": {
"readonly": true,
"title": "Amount of unused RAM in the system, in kilobytes",
"type": "integer"
},
"mem_slab": {
"readonly": true,
"title": "Amount of RAM allocated to the kernel slab allocator, in kilobytes",
"type": "integer"
},
"mem_slab_reclaimable": {
"readonly": true,
"title": "Amount of RAM allocated to the kernel slab allocator that is not currently in use, in kilobytes",
"type": "integer"
},
"mem_total": {
"readonly": true,
"title": "Amount of RAM allocated to the system, in kilobytes",
"type": "integer"
},
"mem_used": {
"readonly": true,
"title": "Amount of RAM in use on the system, in kilobytes. (This is mem_total - mem_available)",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"swap_total": {
"readonly": true,
"title": "Amount of disk available for swap, in kilobytes",
"type": "integer"
},
"swap_used": {
"readonly": true,
"title": "Amount of swap disk in use, in kilobytes",
"type": "integer"
},
"system_time": {
"$ref": "EpochMsTimestamp,
"readonly": true,
"title": "Current time expressed in milliseconds since epoch"
},
"uptime": {
"readonly": true,
"title": "Milliseconds since system start",
"type": "integer"
}
},
"title": "Node status properties",
"type": "object"
}
NodeSyslogExporterProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeSyslogExporterProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"exporter_name": {
"required": true,
"title": "Syslog exporter name",
"type": "string"
},
"facilities": {
"items": {
"$ref": "SyslogFacility
},
"title": "Facilities to export",
"type": "array"
},
"level": {
"enum": [
"EMERG",
"ALERT",
"CRIT",
"ERR",
"WARNING",
"NOTICE",
"INFO",
"DEBUG"
],
"required": true,
"title": "Logging level to export",
"type": "string"
},
"msgids": {
"items": {
"pattern": "^.+$",
"type": "string"
},
"title": "MSGIDs to export",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"port": {
"maximum": 65535,
"minimum": 1,
"title": "Port to export to, defaults to 514 for TCP, TLS, UDP protocols or 9000 for LI, LI-TLS protocols",
"type": "integer"
},
"protocol": {
"enum": [
"TCP",
"TLS",
"UDP",
"LI",
"LI-TLS"
],
"required": true,
"title": "Export protocol",
"type": "string"
},
"server": {
"$ref": "HostnameOrIPv46Address,
"required": true,
"title": "IP address or hostname of server to export to",
"type": "string"
},
"structured_data": {
"items": {
"pattern": "^(alarmId|alarmState|audit|comp|depr|entId|eReqId|errorCode|eventFeatureName|eventId|eventSev|eventState|eventType|euser|inst|level|method|nodeId|org|path|proj|security|site|subcomp|s2comp|splitId|splitIndex|tenantId|tid|tname|update|username|vpc|namespace)=.+$",
"type": "string"
},
"title": "Structured data to export",
"type": "array"
},
"tls_ca_pem": {
"title": "CA certificate PEM of TLS server to export to",
"type": "string"
},
"tls_cert_pem": {
"title": "Certificate PEM of the rsyslog client",
"type": "string"
},
"tls_client_ca_pem": {
"title": "CA certificate PEM of the rsyslog client",
"type": "string"
},
"tls_key_pem": {
"sensitive": true,
"title": "Private key PEM of the rsyslog client",
"type": "string"
}
},
"title": "Node syslog exporter properties",
"type": "object"
}
NodeSyslogExporterPropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "NodeSyslogExporterPropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "NodeSyslogExporterProperties
},
"required": true,
"title": "Node syslog exporter results",
"type": "array"
}
},
"title": "Node syslog exporter list results",
"type": "object"
}
NodeTime (type)
{
"additionalProperties": false,
"description": "Node system time in UTC",
"id": "NodeTime",
"properties": {
"system_datetime": {
"$ref": "DatetimeUTC,
"required": true,
"title": "Datetime string in UTC"
}
},
"title": "Node system time in UTC",
"type": "object"
}
NodeUserProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Resource
},
"id": "NodeUserProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"full_name": {
"title": "Full name for the user",
"type": "string"
},
"group_id": {
"maximum": 2147483647,
"minimum": 0,
"readonly": true,
"title": "Primary group id for the user",
"type": "integer"
},
"home_dir": {
"readonly": true,
"title": "The absolute path of user home directory",
"type": "string"
},
"last_password_change": {
"maximum": 2147483647,
"minimum": 0,
"readonly": true,
"title": "Number of days since password was last changed",
"type": "integer"
},
"login_shell": {
"readonly": true,
"title": "The absolute path of login shell",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"old_password": {
"sensitive": true,
"title": "Old password for the user (required on PUT if password specified)",
"type": "string"
},
"password": {
"sensitive": true,
"title": "Password for the user (optionally specified on PUT, unspecified on GET)",
"type": "string"
},
"password_change_frequency": {
"default": 90,
"description": "Number of days password is valid before it must be changed. This can be set to 0 to indicate no password change is required or a positive integer up to 9999. By default local user passwords must be changed every 90 days.",
"maximum": 9999,
"minimum": 0,
"title": "Number of days password is valid before it must be changed",
"type": "integer"
},
"password_change_warning": {
"default": 7,
"desciption": "Number of days before user receives warning message to change the password before it expires. By default users will receive 7 days prior warning message to change the password.",
"maximum": 9999,
"minimum": 0,
"title": "Number of days before user receives warning message of password expiration",
"type": "integer"
},
"password_reset_required": {
"title": "Boolean value that states if a password reset is required",
"type": "boolean"
},
"status": {
"description": "Status of the user. This value can be ACTIVE indicating authentication attempts will be successful if the correct credentials are specified. The value can also be PASSWORD_EXPIRED indicating authentication attempts will fail because the user's password has expired and must be changed. Or, this value can be NOT_ACTIVATED indicating the user's password has not yet been set and must be set before the user can authenticate.",
"enum": [
"ACTIVE",
"PASSWORD_EXPIRED",
"NOT_ACTIVATED"
],
"readonly": true,
"title": "User status",
"type": "string"
},
"userid": {
"maximum": 2147483647,
"minimum": 0,
"readonly": true,
"title": "Numeric id for the user",
"type": "integer"
},
"username": {
"maxLength": 32,
"minLength": 1,
"pattern": "^[a-zA-Z][a-zA-Z0-9@-_.\\-]*$",
"title": "User login name (must be \"root\" if userid is 0)",
"type": "string"
}
},
"title": "Node user properties",
"type": "object"
}
NodeUserPropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "NodeUserPropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "NodeUserProperties
},
"required": true,
"title": "List of node users",
"type": "array"
}
},
"title": "Node users list results",
"type": "object"
}
NodeVersion (type)
{
"additionalProperties": false,
"id": "NodeVersion",
"properties": {
"node_version": {
"readonly": true,
"title": "Node version",
"type": "string"
},
"product_version": {
"readonly": true,
"title": "Product version",
"type": "string"
}
},
"type": "object"
}
NodeVtepState (type)
{
"enum": [
"UP",
"DOWN",
"UNKNOWN"
],
"id": "NodeVtepState",
"title": "VTEP interfaces State",
"type": "string"
}
NtpServiceProperties (type)
{
"additionalProperties": false,
"id": "NtpServiceProperties",
"properties": {
"servers": {
"items": {
"$ref": "HostnameOrIPv46Address
},
"required": true,
"title": "NTP servers",
"type": "array"
},
"start_on_boot": {
"default": true,
"required": false,
"title": "Start NTP service when system boots",
"type": "boolean"
}
},
"title": "NTP Service properties",
"type": "object"
}
OwnerResourceLink (type)
{
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"extends": {
"$ref": "ResourceLink
},
"id": "OwnerResourceLink",
"properties": {
"action": {
"title": "Optional action",
"type": "string"
},
"href": {
"required": true,
"type": "string"
},
"rel": {
"enum": [
"owner"
],
"readonly": true,
"type": "string"
}
},
"title": "Link to this resource",
"type": "object"
}
PasswordAuthenticationScheme (type)
{
"additionalProperties": false,
"extends": {
"$ref": "AuthenticationScheme
},
"id": "PasswordAuthenticationScheme",
"properties": {
"identity_file": {
"sensitive": true,
"title": "SSH private key file name",
"type": "string"
},
"password": {
"sensitive": true,
"title": "Password to authenticate with",
"type": "string"
},
"scheme_name": {
"enum": [
"password",
"key"
],
"required": true,
"title": "Authentication scheme name",
"type": "string"
},
"username": {
"pattern": "^.+$",
"required": true,
"title": "User name to authenticate with",
"type": "string"
}
},
"type": "object"
}
PasswordComplexityProperties (type)
{
"additionalProperties": {},
"description": "Configurable properties of password complexity requirement for the NSX node.",
"extends": {
"$ref": "Resource
},
"id": "PasswordComplexityProperties",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_retry_prompt": {
"default": 3,
"readonly": true,
"title": "Prompt user at most N times before returning with error.",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"digits": {
"default": -1,
"description": "Number of digits (0..9) expected in user password. <p>N < 0, to set minimum credit for having digits in the new password, i.e. this is the minimum number of digits that must be met for a new password.</p> <p>N > 0, to set maximum credit for having digits in the new password, i.e. per occurrence of digit in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> digits.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 digit is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of digits in password",
"type": "integer"
},
"hash_algorithm": {
"default": "sha512",
"description": "Sets hash/cryptographic algorithm type for new passwords.",
"enum": [
"sha512",
"sha256"
],
"title": "Hash algorithm",
"type": "string"
},
"lower_chars": {
"default": -1,
"description": "Number of lower case characters (a..z) expected in user password. <p>N < 0, to set minimum credit for having lower case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having lower case characters in the new password, i.e. per occurrence of lower case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> lower case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 lower case character is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of lower-case characters in password",
"type": "integer"
},
"max_repeats": {
"default": 0,
"description": "Reject passwords which contain more than N same consecutive characters, like aaa or 7777. To disable the check, value should be set to 0.",
"maximum": 128,
"minimum": 0,
"title": "Number of same consecutive characters",
"type": "integer"
},
"max_sequence": {
"default": 0,
"description": "Reject passwords which contain more than N monotonic character sequences. Monotonic sequences can be '12345' or 'fedcb'. To disable the check, value should be set to 0.",
"maximum": 128,
"minimum": 0,
"title": "Length of permissible monotonic sequence in password substring",
"type": "integer"
},
"maximum_password_length": {
"default": 128,
"description": "Maximum number of characters allowed in password; user can not set their password of length greater than this parameter. By default maximum length of password is 128 characters.",
"maximum": 128,
"minimum": 8,
"title": "Maximum password length",
"type": "integer"
},
"minimum_password_length": {
"default": 12,
"description": "Minimum number of characters expected in password; user can not set their password of length less than this parameter.<br /> NOTE, for existing users upgrading to NSX-T datacenter version 4.0 or above - <p>if existing appliance is configured with <code>minimum_password_length</code> less than current default value, then upgraded appliance will reset the configured setting back to recommended default; which can be explicitly modified back to original value or any other integer greater than or equal to supported minimum value.</p> <p>VMware recommends to set strong passwords for systems and appliances, further suggests to maintain strong <code>minimum_password_length</code> value. NSX resets this value to default and recommends to maintain upgraded default value or above for password complexity requirement.</p> <p>If any existing user passwords are set with length of less than newly configured <code>minimum_password_length</code>, then its recommended to reset the user passwords as per newly configured password complexity compliance.</p> <p>If existing <code>minimum_password_length</code> is greater than or equal to default value, which shall be retained as it is in newly upgraded appliance.</p> By default minimum length of password is 12 characters and passwords less than 8 characters are never allowed.",
"maximum": 128,
"minimum": 8,
"title": "Minimum password length",
"type": "integer"
},
"minimum_unique_chars": {
"default": 0,
"description": "Number of character changes in the new password that differentiate it from the old password. To disable the check, value should be set to 0.",
"maximum": 128,
"minimum": 0,
"title": "Number of unique characters from old password",
"type": "integer"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"password_remembrance": {
"default": 0,
"description": "Limit using a password that was used in past; users can not set the same password within the N generations. To disable the check, value should be set to 0.",
"minimum": 0,
"title": "Password remembrance from previous generations",
"type": "integer"
},
"special_chars": {
"default": -1,
"description": "Number of special characters (!@#$&*..) expected in user password. <p>N < 0, to set minimum credit for having special characters in the new password, i.e. this is the minimum number of special characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having special characters in the new password, i.e. per occurrence of special case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> special case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 special character is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of special characters in password",
"type": "integer"
},
"upper_chars": {
"default": -1,
"description": "Number of upper case characters (A..Z) expected in user password. <p>N < 0, to set minimum credit for having upper case characters in the new password, i.e. this is the minimum number of lower case characters that must be met for a new password.</p> <p>N > 0, to set maximum credit for having upper case characters in the new password, i.e. per occurrence of upper case character in password will attribute additional credit of +1 towards meeting the current <b>minimum_password_length</b> value upto <b>N</b> upper case characters.</p> <p>N = 0, policy will be not applicable.</p> By default minimum 1 upper case character is required for a new password.",
"maximum": 128,
"minimum": -128,
"title": "Number of upper-case characters in password",
"type": "integer"
}
},
"title": "Configurable properties of password complexity requirement for the NSX node",
"type": "object"
}
PhysicalPortQueueStats (type)
{
"additionalProperties": false,
"description": "Provides the packet statistics for individual queues of a physical port since the port uptime. The statistics will be reset on edge reboot or edge dataplane restart. - Total number of incoming packets in the queue. - Total number of outgoing packets in the queue. - Total number of dropped packets in the queue.",
"id": "PhysicalPortQueueStats",
"properties": {
"id": {
"readonly": true,
"title": "Queue ID",
"type": "integer"
},
"rx_bytes": {
"description": "The total number of incoming packet bytes received in the queue. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Bytes in",
"type": "integer"
},
"rx_errors": {
"description": "The total number of erroneous incoming packets received in the queue. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Rx errors",
"type": "integer"
},
"rx_packets": {
"description": "The total number of incoming packets in the queue. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Packets in",
"type": "integer"
},
"tx_bytes": {
"description": "The total number of outgoing packet bytes transmitted from the queue. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Bytes out",
"type": "integer"
},
"tx_drops": {
"description": "The total number of outgoing packets dropped due to buffer overflow. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Tx drops",
"type": "integer"
},
"tx_packets": {
"description": "The total number of outgoing packets transmitted from the queue. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Packets out",
"type": "integer"
}
},
"title": "Physical port queue statistics",
"type": "object"
}
PhysicalPortStats (type)
{
"additionalProperties": false,
"description": "Provides the following statistics of a physical port since the uptime. For edge VM form factor it refers to vmxnet3 vNIC stats. The statistics will be reset on edge reboot or edge dataplane restart. It includes the following information: - Statistics of individual queues of the specific port. - Total number of incoming packets on the port. - Total number of outgoing packets on the port. - Total number of dropped packets on the port. - Error/Failure reason for the dropped packets.",
"id": "PhysicalPortStats",
"properties": {
"name": {
"readonly": true,
"title": "Name",
"type": "string"
},
"queues": {
"description": "Lists the statistics of individual queues of a specific port. It includes the number of incoming, outgoing and dropped packet counters. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"items": {
"$ref": "PhysicalPortQueueStats
},
"title": "Per queue statistics",
"type": "array"
},
"rx_bytes": {
"description": "The total number of bytes received on the port. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Bytes in",
"type": "integer"
},
"rx_errors": {
"description": "The total number of erroneous packets received on the port. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Rx errors",
"type": "integer"
},
"rx_misses": {
"description": "The total number of incoming packets dropped due to Rx buffer overflow or busy Fast Path(FP) core. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Rx misses",
"type": "integer"
},
"rx_nombufs": {
"description": "The total number of incoming packets dropped due to Rx mBuf allocation failure. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Rx no mBufs",
"type": "integer"
},
"rx_packets": {
"description": "The total number of incoming packets on the port. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Packets in",
"type": "integer"
},
"tx_bytes": {
"description": "The total number of bytes transmitted on the port. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Bytes out",
"type": "integer"
},
"tx_drops": {
"description": "The total number of outgoing packets dropped due to Tx buffer overflow. The vmxnet3 backend or the physical NIC is not able to process all the packets that edge is attempting to send out. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Tx drops",
"type": "integer"
},
"tx_errors": {
"description": "The total number of erroneous packets failed to be transmitted. The counts are from the time the edge dataplane is UP and will be reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Tx errors",
"type": "integer"
},
"tx_packets": {
"description": "The total number of outgoing packets on the port since the uptime. This is reset on edge reboot or edge dataplane restart.",
"readonly": true,
"title": "Packets out",
"type": "integer"
}
},
"title": "Physical port statistics",
"type": "object"
}
PolicyBasedIPSecVPNSession (type)
{
"additionalProperties": false,
"description": "A Policy Based VPN requires to define protect rules that match local and peer subnets. IPSec security associations is negotiated for each pair of local and peer subnet.",
"extends": {
"$ref": "IPSecVPNSession
},
"id": "PolicyBasedIPSecVPNSession",
"polymorphic-type-descriptor": {
"type-identifier": "PolicyBasedIPSecVPNSession"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"authentication_mode": {
"default": "PSK",
"description": "Authentication mode used for the peer authentication. For PSK (Pre Shared Key) authentication mode, 'psk' property is mandatory and for the CERTIFICATE authentication mode, 'peer_id' property is mandatory.",
"enum": [
"PSK",
"CERTIFICATE"
],
"title": "Authentication Mode",
"type": "string"
},
"connection_initiation_mode": {
"default": "INITIATOR",
"description": "Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.",
"enum": [
"INITIATOR",
"RESPOND_ONLY",
"ON_DEMAND"
],
"title": "Connection initiation mode",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"dpd_profile_id": {
"description": "Dead peer detection (DPD) profile id. Default will be set according to system default policy.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "Dead peer detection (DPD) profile id",
"type": "string"
},
"enabled": {
"default": true,
"description": "Enable/Disable IPSec VPN session.",
"title": "Enable/Disable IPSec VPN session",
"type": "boolean"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"ike_profile_id": {
"description": "IKE profile id to be used. Default will be set according to system default policy.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "Internet key exchange (IKE) profile id",
"type": "string"
},
"ipsec_tunnel_profile_id": {
"description": "Tunnel profile id to be used. By default it will point to system default profile.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "IPSec tunnel profile id",
"type": "string"
},
"local_endpoint": {
"$ref": "IPSecVPNLocalEndpoint,
"description": "Local endpoint.",
"required": true,
"title": "Local endpoint"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"peer_address": {
"description": "IPV4 address of peer endpoint on remote site.",
"required": true,
"title": "IPV4 address of peer endpoint on remote site.",
"type": "string"
},
"peer_id": {
"description": "Peer identifier.",
"required": true,
"title": "Peer id",
"type": "string"
},
"policy_rules": {
"items": {
"$ref": "IPSecVPNPolicyRule
},
"required": true,
"title": "Policy rules",
"type": "array"
},
"psk": {
"description": "IPSec Pre-shared key. Maximum length of this field is 128 characters. Its required input in PSK authentication mode.",
"maximum": 128,
"minimum": 1,
"required": false,
"sensitive": true,
"title": "Pre-shared key",
"type": "string"
},
"resource_type": {
"$ref": "IPSecVPNSessionResourceType,
"required": true
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"tcp_mss_clamping": {
"$ref": "TcpMssClamping,
"required": false
}
},
"title": "Policy based VPN session",
"type": "object"
}
Protocol (type)
{
"abstract": true,
"additionalProperties": {},
"id": "Protocol",
"polymorphic-type-descriptor": {
"mode": "enabled",
"property-name": "name"
},
"properties": {
"name": {
"enum": [
"http",
"https",
"scp",
"sftp"
],
"required": true,
"title": "Protocol name",
"type": "string"
}
},
"type": "object"
}
ReplicaAgentClientStatusProperties (type)
{
"additionalProperties": false,
"id": "ReplicaAgentClientStatusProperties",
"properties": {
"last_fullsync_time": {
"title": "Timestamp when replica-agent performed last fullsync of messages from primary node's Nestdb",
"type": "string"
},
"last_replication_time": {
"title": "Timestamp when replica-agent performed last replication from primary node.",
"type": "string"
},
"last_rewrite_time": {
"title": "Timestamp when replica-agent performed last rewriting of message in secondary node's Nestdb",
"type": "string"
},
"local_nestdb_connection_time": {
"title": "Timestamp when replica-agent established connection to Nestdb local to the secondary node.",
"type": "string"
},
"node_api_server_role": {
"enum": [
"PRIMARY",
"SECONDARY"
],
"title": "Node High Availability Mode",
"type": "string"
},
"node_id": {
"title": "Node UUID",
"type": "string"
},
"peer_nestdb_connection_time": {
"title": "Timestamp when replica-agent established connection to the NestDB of primary node",
"type": "string"
}
},
"type": "object"
}
Resource (type)
{
"id": "Resource",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"type": "object"
}
ResourceLink (type)
{
"additionalProperties": false,
"id": "ResourceLink",
"properties": {
"action": {
"title": "Optional action",
"type": "string"
},
"href": {
"required": true,
"type": "string"
},
"rel": {
"description": "Custom relation type (follows RFC 5988 where appropriate definitions exist)",
"required": true,
"title": "Link relation type",
"type": "string"
}
},
"type": "object"
}
ResourceReference (type)
{
"description": "A weak reference to an NSX resource.",
"id": "ResourceReference",
"properties": {
"is_valid": {
"description": "Will be set to false if the referenced NSX resource has been deleted.",
"readonly": true,
"required": false,
"title": "Target validity",
"type": "boolean"
},
"target_display_name": {
"description": "Display name of the NSX resource.",
"maxLength": 255,
"readonly": true,
"required": false,
"title": "Target display name",
"type": "string"
},
"target_id": {
"description": "Identifier of the NSX resource.",
"maxLength": 64,
"readonly": false,
"required": false,
"title": "Target ID",
"type": "string"
},
"target_type": {
"description": "Type of the NSX resource.",
"maxLength": 255,
"readonly": false,
"required": false,
"title": "Target type",
"type": "string"
}
},
"type": "object"
}
RevisionedResource (type)
{
"abstract": true,
"extends": {
"$ref": "Resource
},
"id": "RevisionedResource",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
}
},
"title": "A base class for types that track revisions",
"type": "object"
}
RouteBasedIPSecVPNSession (type)
{
"additionalProperties": false,
"description": "A Route Based VPN is more flexible, more powerful and recommended over policy based VPN. IP Tunnel port is created and all traffic routed via tunnel port is protected. Routes can be configured statically or can be learned through BGP. A route based VPN is must for establishing redundant VPN session to remote site.",
"extends": {
"$ref": "IPSecVPNSession
},
"id": "RouteBasedIPSecVPNSession",
"polymorphic-type-descriptor": {
"type-identifier": "RouteBasedIPSecVPNSession"
},
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"authentication_mode": {
"default": "PSK",
"description": "Authentication mode used for the peer authentication. For PSK (Pre Shared Key) authentication mode, 'psk' property is mandatory and for the CERTIFICATE authentication mode, 'peer_id' property is mandatory.",
"enum": [
"PSK",
"CERTIFICATE"
],
"title": "Authentication Mode",
"type": "string"
},
"connection_initiation_mode": {
"default": "INITIATOR",
"description": "Connection initiation mode used by local endpoint to establish ike connection with peer endpoint. INITIATOR - In this mode local endpoint initiates tunnel setup and will also respond to incoming tunnel setup requests from peer gateway. RESPOND_ONLY - In this mode, local endpoint shall only respond to incoming tunnel setup requests. It shall not initiate the tunnel setup. ON_DEMAND - In this mode local endpoint will initiate tunnel creation once first packet matching the policy rule is received and will also respond to incoming initiation request.",
"enum": [
"INITIATOR",
"RESPOND_ONLY",
"ON_DEMAND"
],
"title": "Connection initiation mode",
"type": "string"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"dpd_profile_id": {
"description": "Dead peer detection (DPD) profile id. Default will be set according to system default policy.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "Dead peer detection (DPD) profile id",
"type": "string"
},
"enabled": {
"default": true,
"description": "Enable/Disable IPSec VPN session.",
"title": "Enable/Disable IPSec VPN session",
"type": "boolean"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"ike_profile_id": {
"description": "IKE profile id to be used. Default will be set according to system default policy.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "Internet key exchange (IKE) profile id",
"type": "string"
},
"ipsec_tunnel_profile_id": {
"description": "Tunnel profile id to be used. By default it will point to system default profile.",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$",
"title": "IPSec tunnel profile id",
"type": "string"
},
"local_endpoint": {
"$ref": "IPSecVPNLocalEndpoint,
"description": "Local endpoint.",
"required": true,
"title": "Local endpoint"
},
"multi_path_group_id": {
"description": "Specify a multiple path group for the IPSec session to join for utilizing multipath functionality.",
"title": "IPSec VPN multiple path group identifier",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"peer_address": {
"description": "IPV4 address of peer endpoint on remote site.",
"required": true,
"title": "IPV4 address of peer endpoint on remote site.",
"type": "string"
},
"peer_id": {
"description": "Peer identifier.",
"required": true,
"title": "Peer id",
"type": "string"
},
"psk": {
"description": "IPSec Pre-shared key. Maximum length of this field is 128 characters. Its required input in PSK authentication mode.",
"maximum": 128,
"minimum": 1,
"required": false,
"sensitive": true,
"title": "Pre-shared key",
"type": "string"
},
"resource_type": {
"$ref": "IPSecVPNSessionResourceType,
"required": true
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
},
"tcp_mss_clamping": {
"$ref": "TcpMssClamping,
"required": false
},
"tunnel_ports": {
"description": "IP Tunnel ports.",
"items": {
"$ref": "TunnelPortConfig
},
"maxItems": 1,
"minItems": 1,
"required": true,
"title": "IP Tunnel ports",
"type": "array"
}
},
"title": "Route based VPN session",
"type": "object"
}
RouteType (type)
{
"enum": [
"route",
"neighbor",
"connected",
"blackhole",
"unknown"
],
"id": "RouteType",
"title": "Route Type",
"type": "string"
}
ScpProtocol (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Protocol
},
"id": "ScpProtocol",
"polymorphic-type-descriptor": {
"type-identifier": "scp"
},
"properties": {
"authentication_scheme": {
"$ref": "PasswordAuthenticationScheme,
"required": true,
"title": "Scheme to authenticate if required"
},
"host_key_algorithms": {
"default": [
"ecdsa-sha2-nistp256",
"ecdsa-sha2-nistp384",
"ecdsa-sha2-nistp521"
],
"description": "Supported host key algorithms for SSH/SFTP connection.<br /> <i>Algorithms are preferred in the order they are specified in list.</i>",
"items": {
"$ref": "HostKeyAlgorithms
},
"minItems": 1,
"required": false,
"title": "Host key algorithms",
"type": "array"
},
"name": {
"enum": [
"http",
"https",
"scp",
"sftp"
],
"required": true,
"title": "Protocol name",
"type": "string"
},
"ssh_fingerprint": {
"required": true,
"title": "SSH fingerprint of server",
"type": "string"
}
},
"type": "object"
}
SelfResourceLink (type)
{
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"extends": {
"$ref": "ResourceLink
},
"id": "SelfResourceLink",
"properties": {
"action": {
"title": "Optional action",
"type": "string"
},
"href": {
"required": true,
"type": "string"
},
"rel": {
"enum": [
"self"
],
"readonly": true,
"type": "string"
}
},
"title": "Link to this resource",
"type": "object"
}
ServiceType (type)
{
"enum": [
"MGMT_CLUSTER",
"MGMT_PLANE",
"API",
"NOTIFICATION_COLLECTOR",
"SYSLOG_SERVER",
"RSYSLOG_CLIENT"
],
"id": "ServiceType",
"title": "Supported service types, that are using certificates.",
"type": "string"
}
SftpProtocol (type)
{
"additionalProperties": false,
"extends": {
"$ref": "Protocol
},
"id": "SftpProtocol",
"polymorphic-type-descriptor": {
"type-identifier": "sftp"
},
"properties": {
"authentication_scheme": {
"$ref": "PasswordAuthenticationScheme,
"required": true,
"title": "Scheme to authenticate if required"
},
"host_key_algorithms": {
"default": [
"ecdsa-sha2-nistp256",
"ecdsa-sha2-nistp384",
"ecdsa-sha2-nistp521"
],
"description": "Supported host key algorithms for SSH/SFTP connection.<br /> <i>Algorithms are preferred in the order they are specified in list.</i>",
"items": {
"$ref": "HostKeyAlgorithms
},
"minItems": 1,
"required": false,
"title": "Host key algorithms",
"type": "array"
},
"name": {
"enum": [
"http",
"https",
"scp",
"sftp"
],
"required": true,
"title": "Protocol name",
"type": "string"
},
"ssh_fingerprint": {
"required": true,
"title": "SSH fingerprint of server",
"type": "string"
}
},
"type": "object"
}
SnmpCommunity (type)
{
"additionalProperties": false,
"description": "SNMP v1, v2c community.",
"id": "SnmpCommunity",
"properties": {
"access": {
"default": "read_only",
"description": "Access permissions for this community.",
"enum": [
"read_only"
],
"title": "Type of access",
"type": "string"
},
"community_string": {
"description": "Community alias string at most 64 characters long.",
"required": false,
"sensitive": true,
"title": "Community string at most 64 characters long",
"type": "string"
}
},
"title": "SNMP v1, v2c community",
"type": "object"
}
SnmpServiceProperties (type)
{
"additionalProperties": false,
"id": "SnmpServiceProperties",
"properties": {
"communities": {
"items": {
"$ref": "SnmpCommunity
},
"maxItems": 10,
"required": false,
"title": "SNMP v1, v2c community",
"type": "array"
},
"start_on_boot": {
"required": false,
"title": "Start when system boots",
"type": "boolean"
},
"v2_configured": {
"description": "Indicates whether the local SNMP agent is configured with community string(s).",
"readonly": true,
"title": "SNMP v2 is configured or not",
"type": "boolean"
},
"v2_targets": {
"items": {
"$ref": "SnmpV2Target
},
"maxItems": 3,
"required": false,
"title": "SNMP v2c targets information",
"type": "array"
},
"v3_auth_protocol": {
"default": "SHA1",
"enum": [
"SHA1"
],
"required": false,
"title": "SNMP v3 auth protocol",
"type": "string"
},
"v3_configured": {
"description": "Indicates whether the local SNMP agent is configured with v3 user(s).",
"readonly": true,
"title": "SNMP v3 is configured or not",
"type": "boolean"
},
"v3_priv_protocol": {
"default": "AES128",
"enum": [
"AES128"
],
"required": false,
"title": "SNMP v3 private protocol",
"type": "string"
},
"v3_targets": {
"items": {
"$ref": "SnmpV3Target
},
"maxItems": 3,
"required": false,
"title": "SNMP v3 targets information",
"type": "array"
},
"v3_users": {
"items": {
"$ref": "SnmpV3User
},
"maxItems": 5,
"required": false,
"title": "SNMP v3 users information",
"type": "array"
}
},
"title": "SNMP Service properties",
"type": "object"
}
SnmpV2Target (type)
{
"description": "SNMP v2c manager's reachability information.",
"id": "SnmpV2Target",
"properties": {
"community_string": {
"description": "Community alias string at most 64 characters long.",
"required": false,
"sensitive": true,
"title": "Community string",
"type": "string"
},
"port": {
"default": 162,
"description": "SNMP v2c manager's port.",
"maximum": 65535,
"minimum": 1,
"required": false,
"title": "SNMP v2c manager port",
"type": "integer"
},
"server": {
"$ref": "HostnameOrIPv46Address,
"description": "SNMP v2c manager's IP or FQDN.",
"required": true,
"title": "SNMP v2c manager",
"type": "string"
}
},
"title": "SNMP v2c targets information",
"type": "object"
}
SnmpV3Target (type)
{
"description": "SNMP v3 manager's reachability information.",
"id": "SnmpV3Target",
"properties": {
"port": {
"default": 162,
"description": "SNMP v2c manager's port.",
"maximum": 65535,
"minimum": 1,
"required": false,
"title": "SNMP v2c manager port",
"type": "integer"
},
"security_level": {
"default": "AUTH_PRIV",
"description": "SNMP v3 security level.",
"enum": [
"AUTH_PRIV"
],
"title": "Security level",
"type": "string"
},
"server": {
"$ref": "HostnameOrIPv46Address,
"description": "Specify the fully qualified domain name, or ip address, of the server.",
"required": true,
"title": "FQDN or IP address of the SNMP Manager",
"type": "string"
},
"user_id": {
"description": "Specify the user name used to authenticate with the SNMP Manager.",
"required": true,
"title": "SNMP v3 user id",
"type": "string"
}
},
"title": "SNMP v3 targets information",
"type": "object"
}
SnmpV3User (type)
{
"id": "SnmpV3User",
"properties": {
"access": {
"default": "READ_ONLY",
"description": "Access permissions for this User.",
"enum": [
"READ_ONLY"
],
"readonly": true,
"title": "Type of access",
"type": "string"
},
"auth_password": {
"required": false,
"sensitive": true,
"title": "SNMP v3 user auth password",
"type": "string"
},
"priv_password": {
"required": false,
"sensitive": true,
"title": "SNMP v3 user private password",
"type": "string"
},
"security_level": {
"default": "AUTH_PRIV",
"description": "SNMP v3 security level.",
"enum": [
"AUTH_PRIV"
],
"readonly": true,
"title": "Security level",
"type": "string"
},
"user_id": {
"required": true,
"title": "SNMP v3 user id",
"type": "string"
}
},
"type": "object"
}
SshFingerprintProperties (type)
{
"additionalProperties": false,
"description": "Server properties - hostname/ip_address, port and ssh fingerprint",
"id": "SshFingerprintProperties",
"properties": {
"host_key_algorithms": {
"default": [
"ecdsa-sha2-nistp256",
"ecdsa-sha2-nistp384",
"ecdsa-sha2-nistp521"
],
"description": "Supported host key algorithms for SSH/SFTP connection.<br /> <i>Algorithms are preferred in the order they are specified in list.</i>",
"items": {
"$ref": "HostKeyAlgorithms
},
"minItems": 1,
"required": false,
"title": "Host key algorithms",
"type": "array"
},
"port": {
"description": "Remote server port on which ssh connection is made.",
"maximum": 65535,
"minimum": 1,
"required": true,
"title": "Server port",
"type": "integer"
},
"server": {
"description": "Server hostname/ip_address for which fingerprint has been retrieved.",
"pattern": "^.+$",
"required": true,
"title": "Remote server hostname or IP address",
"type": "string"
},
"ssh_fingerprint": {
"description": "Remote server's ssh fingerprint.",
"title": "SSH fingerprint of server",
"type": "string"
}
},
"title": "Server ssh fingerprint properties",
"type": "object"
}
SshKeyBaseProperties (type)
{
"additionalProperties": {},
"id": "SshKeyBaseProperties",
"properties": {
"label": {
"required": true,
"title": "SSH key label (used to identify the key)",
"type": "string"
},
"password": {
"required": false,
"sensitive": true,
"title": "Current password for user (required for users root and admin)",
"type": "string"
}
},
"type": "object"
}
SshKeyProperties (type)
{
"additionalProperties": false,
"extends": {
"$ref": "SshKeyBaseProperties
},
"id": "SshKeyProperties",
"properties": {
"label": {
"required": true,
"title": "SSH key label (used to identify the key)",
"type": "string"
},
"password": {
"required": false,
"sensitive": true,
"title": "Current password for user (required for users root and admin)",
"type": "string"
},
"type": {
"pattern": "^(ecdsa-sha2-nistp256|ecdsa-sha2-nistp384|ecdsa-sha2-nistp521|ssh-dss|ssh-ed25519|ssh-rsa)$",
"required": true,
"title": "SSH key type",
"type": "string"
},
"value": {
"required": true,
"title": "SSH key value",
"type": "string"
}
},
"type": "object"
}
SshKeyPropertiesListResult (type)
{
"extends": {
"$ref": "ListResult
},
"id": "SshKeyPropertiesListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "SshKeyProperties
},
"required": true,
"title": "SSH key properties query results",
"type": "array"
}
},
"title": "SSH key properties query results",
"type": "object"
}
SshServiceProperties (type)
{
"additionalProperties": false,
"id": "SshServiceProperties",
"properties": {
"root_login": {
"title": "Permit SSH Root login",
"type": "boolean"
},
"start_on_boot": {
"required": true,
"title": "Start service when system boots",
"type": "boolean"
}
},
"title": "SSH Service properties",
"type": "object"
}
StaticRoute (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ManagedResource
},
"id": "StaticRoute",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"network": {
"$ref": "IPv4CIDRBlock,
"required": true,
"title": "CIDR"
},
"next_hops": {
"items": {
"$ref": "StaticRouteNextHop
},
"maxItems": 8,
"minItems": 1,
"required": true,
"title": "Next Hops",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}
StaticRouteListResult (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ListResult
},
"id": "StaticRouteListResult",
"properties": {
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"page_cursor": {
"readonly": true,
"title": "Opaque cursor for next page of results, (not set on last page)",
"type": "string"
},
"result_count": {
"readonly": true,
"title": "Count of results found (across all pages), set only on first page",
"type": "integer"
},
"results": {
"items": {
"$ref": "StaticRoute
},
"required": true,
"title": "Paginated list of static routes",
"type": "array"
}
},
"type": "object"
}
StaticRouteNextHop (type)
{
"additionalProperties": false,
"id": "StaticRouteNextHop",
"properties": {
"administrative_distance": {
"default": 1,
"maximum": 255,
"minimum": 1,
"required": false,
"title": "Administrative Distance for the next hop IP",
"type": "integer"
},
"blackhole_action": {
"$ref": "BlackholeAction,
"readonly": true,
"required": false,
"title": "Action to be taken on matching packets for NULL routes."
},
"ip_address": {
"$ref": "IPv4Address,
"required": false,
"title": "Next Hop IP"
},
"logical_router_port_id": {
"$ref": "ResourceReference,
"required": false,
"title": "Reference of logical router port to be used for next hop"
}
},
"type": "object"
}
SupportBundleQueryParameters (type)
{
"additionalProperties": false,
"id": "SupportBundleQueryParameters",
"properties": {
"all": {
"default": false,
"description": "Include all files including files that may have sensitive information like core files.",
"title": "Include all files",
"type": "boolean"
}
},
"type": "object"
}
SyslogFacility (type)
{
"enum": [
"KERN",
"USER",
"MAIL",
"DAEMON",
"AUTH",
"SYSLOG",
"LPR",
"NEWS",
"UUCP",
"AUTHPRIV",
"FTP",
"LOGALERT",
"CRON",
"LOCAL0",
"LOCAL1",
"LOCAL2",
"LOCAL3",
"LOCAL4",
"LOCAL5",
"LOCAL6",
"LOCAL7"
],
"id": "SyslogFacility",
"title": "Syslog facility",
"type": "string"
}
SystemHostname (type)
{
"id": "SystemHostname",
"maxLength": 255,
"pattern": "^(?=.{1,255}$)[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?(?:\\.[0-9A-Za-z](?:(?:[0-9A-Za-z]|-){0,61}[0-9A-Za-z])?)*\\.?$",
"title": "System host name",
"type": "string"
}
Tag (type)
{
"id": "Tag",
"properties": {
"scope": {
"default": "",
"description": "Tag searches may optionally be restricted by scope",
"display": {
"order": 1
},
"maxLength": 128,
"readonly": false,
"title": "Tag scope",
"type": "string"
},
"tag": {
"default": "",
"description": "Identifier meaningful to user",
"display": {
"order": 2
},
"maxLength": 256,
"readonly": false,
"title": "Tag value",
"type": "string"
}
},
"title": "Arbitrary key-value pairs that may be attached to an entity",
"type": "object"
}
TcpMssClamping (type)
{
"additionalProperties": false,
"description": "Tcp Mss Clamping Direction and value",
"id": "TcpMssClamping",
"properties": {
"direction": {
"default": "NONE",
"description": "Specifies the traffic direction for which to apply MSS Clamping.",
"enum": [
"NONE",
"INBOUND_CONNECTION",
"OUTBOUND_CONNECTION",
"BOTH"
],
"required": false,
"title": "MSS Clamping direction",
"type": "string"
},
"max_segment_size": {
"description": "It defines the maximum amount of data that a host is willing to accept in a single TCP segment. This field is set in TCP header during connection establishment. To avoid packet fragmentation, you can set this field depending on uplink MTU and VPN overhead. This is optional field and in case it is left unconfigured, best possible MSS value will be calculated based on effective mtu of uplink interface. Supported MSS range is 108 to 8902.",
"maximum": 8902,
"minimum": 108,
"required": false,
"title": "Maximum Segment Size value",
"type": "integer"
}
},
"title": "Tcp Mss Clamping Object",
"type": "object"
}
TransportNodeInEdgeCluster (type)
{
"additionalProperties": false,
"description": "Transport node parameters.",
"id": "TransportNodeInEdgeCluster",
"properties": {
"interface": {
"description": "Interface properties.",
"items": {
"$ref": "Interface
},
"required": true,
"title": "Interface properties",
"type": "array"
},
"member_index": {
"description": "Transport node index in the edge cluster.",
"required": true,
"title": "Transport node index in the edge cluster",
"type": "integer"
},
"node_id": {
"description": "Transport node ID",
"required": true,
"title": "Transport node ID",
"type": "string"
},
"thumbprint": {
"description": "Transport node thumbprint.",
"required": true,
"title": "Transport node thumbprint",
"type": "string"
}
},
"title": "Transport node parameters",
"type": "object"
}
TransportTunnel (type)
{
"additionalProperties": false,
"description": "For client, L2VPN Session Transport Tunnel uses a peer code which has all the information to create the transport tunnel.",
"id": "TransportTunnel",
"properties": {
"display_name": {
"description": "Name for transport tunnel.",
"required": false,
"title": "Name for transport tunnel",
"type": "string"
},
"ipsec_session_id": {
"description": "Transport tunnel id. When service is in client mode, this is read only.",
"required": false,
"title": "Transport tunnel id",
"type": "string"
},
"local_address": {
"$ref": "IPv4Address,
"description": "IPv4 Address of local endpoint. This is required when service is in client mode.",
"required": false,
"title": "IPv4 Address of local endpoint"
},
"peer_address": {
"$ref": "IPv4Address,
"description": "IPv4 Address of Peer endpoint on remote site. This is required when service is in client mode.",
"required": false,
"title": "IPv4 Address of Peer endpoint"
},
"peer_code": {
"description": "Peer code represents a base64 encoded string which has all the configuration for tunnel. E.g. local/peer ids and protocol, encryption algorithm, etc. Peer code also contains PSK; be careful when sharing or storing it. This is required when service is in client mode.",
"required": false,
"sensitive": true,
"title": "Peer code for the transport tunnel",
"type": "string"
}
},
"title": "L2VPN Session Transport Tunnel",
"type": "object"
}
TrustObjectData (type)
{
"additionalProperties": false,
"extends": {
"$ref": "ManagedResource
},
"id": "TrustObjectData",
"properties": {
"_create_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of resource creation",
"readonly": true
},
"_create_user": {
"description": "ID of the user who created this resource",
"readonly": true,
"type": "string"
},
"_last_modified_time": {
"$ref": "EpochMsTimestamp,
"can_sort": true,
"description": "Timestamp of last modification",
"readonly": true
},
"_last_modified_user": {
"description": "ID of the user who last modified this resource",
"readonly": true,
"type": "string"
},
"_links": {
"description": "The server will populate this field when returing the resource. Ignored on PUT and POST.",
"items": {
"$ref": "ResourceLink
},
"readonly": true,
"title": "References related to this resource",
"type": "array"
},
"_protection": {
"description": "Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.",
"readonly": true,
"title": "Indicates protection status of this resource",
"type": "string"
},
"_revision": {
"description": "The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.",
"readonly": true,
"title": "Generation of this resource config",
"type": "integer"
},
"_schema": {
"display": {
"hidden": true
},
"readonly": true,
"title": "Location of schema for this resource",
"type": "string"
},
"_self": {
"$ref": "SelfResourceLink,
"readonly": true
},
"_system_owned": {
"description": "Indicates system owned resource",
"readonly": true,
"type": "boolean"
},
"actions": {
"items": {
"$ref": "ActionDescriptor
},
"readonly": true,
"title": "Actions applicable to the resource at this time",
"type": "array"
},
"description": {
"can_sort": true,
"maxLength": 1024,
"title": "Description of this resource",
"type": "string"
},
"display_name": {
"can_sort": true,
"description": "Defaults to ID if not set",
"maxLength": 255,
"title": "Identifier to use when displaying entity in logs or GUI",
"type": "string"
},
"id": {
"can_sort": true,
"readonly": true,
"title": "Unique identifier of this resource",
"type": "string"
},
"key_algo": {
"description": "Key algorithm contained in this certificate",
"type": "string"
},
"notify_mpa": {
"default": false,
"description": "send notification to MPA about this config change (applicable on edge node)",
"display": {
"hidden": true
},
"readonly": false,
"type": "boolean"
},
"passphrase": {
"description": "Password for private key encryption",
"readonly": false,
"required": false,
"sensitive": true,
"type": "string"
},
"pem_encoded": {
"description": "pem encoded certificate data",
"readonly": false,
"required": true,
"type": "string"
},
"private_key": {
"description": "private key data",
"readonly": false,
"required": false,
"sensitive": true,
"type": "string"
},
"resource_type": {
"description": "The type of this resource.",
"readonly": false,
"type": "string"
},
"tags": {
"items": {
"$ref": "Tag
},
"maxItems": 30,
"title": "Opaque identifiers meaningful to the API user",
"type": "array"
}
},
"type": "object"
}
TunnelDigestAlgorithm (type)
{
"additionalProperties": false,
"description": "The TunnelDigestAlgorithms are used to verify message integrity during IPSec VPN tunnel establishment. SHA1 produces 160 bits hash and SHA2_XXX produces XXX bit hash.",
"enum": [
"SHA1",
"SHA2_256",
"SHA2_384",
"SHA2_512"
],
"id": "TunnelDigestAlgorithm",
"title": "Digest Algorithms used in tunnel establishment",
"type": "string"
}
TunnelEncryptionAlgorithm (type)
{
"additionalProperties": false,
"description": "TunnelEncryption algorithms are used to ensure confidentiality of the messages exchanged during Tunnel negotiations. AES stands for Advanced Encryption Standards. AES_128 uses 128-bit keys whereas AES_256 uses 256-bit keys for encryption and decryption. AES_GCM stands for Advanced Encryption Standard(AES) in Galois/Counter Mode (GCM) and is used to provide both confidentiality and data origin authentication. NO_ENCRYPTION_AUTH_AES_GMAC_* enables authentication on input data without encyption. Digest algorithm should be empty for this option.",
"enum": [
"AES_128",
"AES_256",
"AES_GCM_128",
"AES_GCM_192",
"AES_GCM_256",
"NO_ENCRYPTION_AUTH_AES_GMAC_128",
"NO_ENCRYPTION_AUTH_AES_GMAC_192",
"NO_ENCRYPTION_AUTH_AES_GMAC_256",
"NO_ENCRYPTION"
],
"id": "TunnelEncryptionAlgorithm",
"title": "Encryption algorithm used in tunnel",
"type": "string"
}
TunnelPortConfig (type)
{
"additionalProperties": false,
"description": "IP Tunnel port configuration.",
"id": "TunnelPortConfig",
"properties": {
"ip_subnets": {
"description": "IP Tunnel port (commonly referred as VTI) subnet.",
"items": {
"$ref": "IPSubnet
},
"maxItems": 1,
"minItems": 1,
"required": true,
"title": "IP Tunnel port subnet",
"type": "array"
},
"tunnel_port_id": {
"description": "Logical route port identifier.",
"readonly": true,
"title": "Logical route port identifier",
"type": "string"
}
},
"title": "IP Tunnel port configuration",
"type": "object"
}
UpgradeProgressStatus (type)
{
"id": "UpgradeProgressStatus",
"properties": {
"last_upgrade_step_status": {
"title": "Status of last upgrade step",
"type": "object"
},
"upgrade_bundle_present": {
"title": "True if upgrade bundle is present",
"type": "boolean"
},
"upgrade_metadata": {
"title": "Meta info of upgrade",
"type": "object"
}
},
"title": "Upgrade progress status",
"type": "object"
}
UpgradeStatusSummary (type)
{
"id": "UpgradeStatusSummary",
"properties": {
"upgrade_bundle_present": {
"title": "True if upgrade bundle is present",
"type": "boolean"
},
"upgrade_metadata": {
"title": "Meta info of upgrade",
"type": "object"
},
"upgrade_steps": {
"items": {
"type": "object"
},
"title": "List of all upgrade steps performed",
"type": "array"
}
},
"title": "Upgrade status summry",
"type": "object"
}
UpgradeTaskActionParameters (type)
{
"id": "UpgradeTaskActionParameters",
"properties": {
"action": {
"description": "The upgrade task to perform.",
"pattern": "^[^/]+$",
"title": "Upgrade task",
"type": "string"
}
},
"type": "object"
}
UpgradeTaskProperties (type)
{
"additionalProperties": false,
"id": "UpgradeTaskProperties",
"properties": {
"bundle_name": {
"required": true,
"title": "Name of Bundle",
"type": "string"
},
"parameters": {
"readonly": true,
"required": false,
"title": "Bundle arguments",
"type": "object"
},
"step": {
"required": false,
"title": "Step name",
"type": "string"
}
},
"title": "Task properties",
"type": "object"
}
UpgradeTaskStatusQueryParameters (type)
{
"id": "UpgradeTaskStatusQueryParameters",
"properties": {
"bundle_name": {
"description": "Provide a bundle name",
"pattern": "^[a-zA-Z0-9-.]+$",
"title": "Bundle Name",
"type": "string"
},
"upgrade_task_id": {
"description": "Provide a task id",
"pattern": "^[a-z0-9-]+$",
"title": "Upgrade Task ID",
"type": "string"
}
},
"type": "object"
}
UrpfMode (type)
{
"enum": [
"NONE",
"STRICT"
],
"id": "UrpfMode",
"title": "Unicast Reverse Path Forwarding mode",
"type": "string"
}
X509Certificate (type)
{
"additionalProperties": false,
"id": "X509Certificate",
"properties": {
"dsa_public_key_g": {
"description": "One of the DSA cryptogaphic algorithm's strength parameters, base",
"readonly": true,
"required": false,
"type": "string"
},
"dsa_public_key_p": {
"description": "One of the DSA cryptogaphic algorithm's strength parameters, prime",
"readonly": true,
"required": false,
"type": "string"
},
"dsa_public_key_q": {
"description": "One of the DSA cryptogaphic algorithm's strength parameters, sub-prime",
"readonly": true,
"required": false,
"type": "string"
},
"dsa_public_key_y": {
"description": "One of the DSA cryptogaphic algorithm's strength parameters",
"readonly": true,
"required": false,
"type": "string"
},
"ecdsa_curve_name": {
"description": "The Curve name for the ECDSA certificate.",
"readonly": true,
"required": false,
"title": "ECDSA Curve Name",
"type": "string"
},
"ecdsa_ec_field": {
"description": "Represents an elliptic curve (EC) finite field in ECDSA.",
"enum": [
"F2M",
"FP"
],
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Finite Field",
"type": "string"
},
"ecdsa_ec_field_f2mks": {
"description": "The order of the middle term(s) of the reduction polynomial in elliptic curve (EC) | characteristic 2 finite field.| Contents of this array are copied to protect against subsequent modification in ECDSA.",
"items": {
"type": "integer"
},
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve F2MKS",
"type": "array"
},
"ecdsa_ec_field_f2mm": {
"description": "The first coefficient of this elliptic curve in elliptic curve (EC) | characteristic 2 finite field for ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve F2MM",
"type": "integer"
},
"ecdsa_ec_field_f2mrp": {
"description": "The value whose i-th bit corresponds to the i-th coefficient of the reduction polynomial | in elliptic curve (EC) characteristic 2 finite field for ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve F2MRP",
"type": "string"
},
"ecdsa_ec_field_f2pp": {
"description": "The specified prime for the elliptic curve prime finite field in ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve F2PP",
"type": "string"
},
"ecdsa_public_key_a": {
"description": "The first coefficient of this elliptic curve in ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Public Key A",
"type": "string"
},
"ecdsa_public_key_b": {
"description": "The second coefficient of this elliptic curve in ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Public Key B",
"type": "string"
},
"ecdsa_public_key_cofactor": {
"description": "The co-factor in ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Public Key Cofactor",
"type": "integer"
},
"ecdsa_public_key_generator_x": {
"description": "x co-ordinate of G (the generator which is also known as the base point) in ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Public Key X",
"type": "string"
},
"ecdsa_public_key_generator_y": {
"description": "y co-ordinate of G (the generator which is also known as the base point) in ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Public Key Y",
"type": "string"
},
"ecdsa_public_key_order": {
"description": "The order of generator G in ECDSA.",
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Public Key Order",
"type": "string"
},
"ecdsa_public_key_seed": {
"description": "The bytes used during curve generation for later validation in ECDSA.| Contents of this array are copied to protect against subsequent modification.",
"items": {
"type": "string"
},
"readonly": true,
"required": false,
"title": "ECDSA Elliptic Curve Public Key Seed",
"type": "array"
},
"is_ca": {
"description": "True if this is a CA certificate.",
"readonly": true,
"required": true,
"type": "boolean"
},
"is_valid": {
"description": "True if this certificate is valid.",
"readonly": true,
"required": true,
"type": "boolean"
},
"issuer": {
"description": "the certificate issuers complete distinguished name",
"readonly": true,
"required": true,
"type": "string"
},
"issuer_cn": {
"description": "the certificate issuer's common name",
"readonly": true,
"required": true,
"type": "string"
},
"not_after": {
"$ref": "EpochMsTimestamp,
"description": "the time in epoch milliseconds at which the certificate becomes invalid",
"readonly": true,
"required": true
},
"not_before": {
"$ref": "EpochMsTimestamp,
"description": "the time in epoch milliseconds at which the certificate becomes valid",
"readonly": true,
"required": true
},
"public_key_algo": {
"description": "Cryptographic algorithm used by the public key for data encryption.",
"enum": [
"RSA",
"DSA",
"ECDSA"
],
"readonly": true,
"required": true,
"title": "Public Key Algorithm",
"type": "string"
},
"public_key_length": {
"description": "size measured in bits of the public/private keys used in a cryptographic algorithm",
"readonly": true,
"required": true,
"type": "integer"
},
"rsa_public_key_exponent": {
"description": "An RSA public key is made up of the modulus and the public exponent. Exponent is a power number",
"readonly": true,
"required": false,
"type": "string"
},
"rsa_public_key_modulus": {
"description": "An RSA public key is made up of the modulus and the public exponent. Modulus is wrap around number",
"readonly": true,
"required": false,
"type": "string"
},
"serial_number": {
"description": "certificate's serial number",
"readonly": true,
"required": true,
"type": "string"
},
"signature": {
"description": "the signature value(the raw signature bits) used for signing and validate the cert",
"readonly": true,
"required": true,
"type": "string"
},
"signature_algorithm": {
"description": "the algorithm used by the Certificate Authority to sign the certificate",
"readonly": true,
"required": true,
"type": "string"
},
"subject": {
"description": "the certificate owners complete distinguished name",
"readonly": true,
"required": true,
"type": "string"
},
"subject_cn": {
"description": "the certificate owner's common name",
"readonly": true,
"required": true,
"type": "string"
},
"version": {
"description": "Certificate version (default v1)",
"readonly": true,
"required": true,
"type": "string"
}
},
"type": "object"
}
X509Crl (type)
{
"additionalProperties": false,
"id": "X509Crl",
"properties": {
"crl_entries": {
"description": "list of X509CrlEntry",
"items": {
"$ref": "X509CrlEntry
},
"readonly": true,
"required": false,
"type": "array"
},
"issuer": {
"description": "Issuer's distinguished name(DN)",
"readonly": true,
"required": false,
"type": "string"
},
"next_update": {
"description": "Next update time for the CRL",
"readonly": true,
"required": false,
"type": "string"
},
"version": {
"description": "CRL's version number either 1 or 2",
"readonly": true,
"required": false,
"type": "string"
}
},
"title": "A CRL is a time-stamped list identifying revoked certificates.",
"type": "object"
}
X509CrlEntry (type)
{
"additionalProperties": false,
"id": "X509CrlEntry",
"properties": {
"revocation_date": {
"description": "Revocation date",
"readonly": true,
"required": false,
"type": "string"
},
"serial_number": {
"description": "the revoked certificate's serial number",
"readonly": true,
"required": false,
"type": "string"
}
},
"title": "Each revoked certificate is identified in a CRL by its certificate serial number.",
"type": "object"
}