diff options
Diffstat (limited to 'static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json')
| -rw-r--r-- | static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json | 103 |
1 files changed, 54 insertions, 49 deletions
diff --git a/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json b/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json index be79b1a30e..738ac27a9f 100644 --- a/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json +++ b/static/redfish/v1/JsonSchemas/IPAddresses/IPAddresses.json @@ -1,6 +1,7 @@ { + "$id": "http://redfish.dmtf.org/schemas/v1/IPAddresses.v1_1_1.json", "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json", - "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", + "copyright": "Copyright 2014-2019 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright", "definitions": { "AddressState": { "enum": [ @@ -10,19 +11,19 @@ "Failed" ], "enumDescriptions": { - "Deprecated": "This address is currently within it's valid lifetime, but is now outside of it's preferred lifetime as defined in RFC 4862.", - "Failed": "This address has failed Duplicate Address Detection testing as defined in RFC 4862 section 5.4 and is not currently in use.", - "Preferred": "This address is currently within both it's valid and preferred lifetimes as defined in RFC 4862.", - "Tentative": "This address is currently undergoing Duplicate Address Detection testing as defined in RFC 4862 section 5.4." + "Deprecated": "This address is currently within its valid lifetime but is now outside its RFC4862-defined preferred lifetime.", + "Failed": "This address has failed Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4, and is not currently in use.", + "Preferred": "This address is currently within both its RFC4862-defined valid and preferred lifetimes.", + "Tentative": "This address is currently undergoing Duplicate Address Detection (DAD) testing, as defined in RFC4862, section 5.4." }, "type": "string" }, "IPv4Address": { "additionalProperties": false, - "description": "This type describes an IPv4 Address.", + "description": "This type describes an IPv4 address.", "longDescription": "This type shall describe an IPv4 address assigned to an interface.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -37,8 +38,8 @@ }, "properties": { "Address": { - "description": "This is the IPv4 Address.", - "longDescription": "The value of this property shall be an IPv4 address assigned to this interface. If DHCPv4 is enabled on the interface, this property becomes read-only.", + "description": "The IPv4 address.", + "longDescription": "This property shall contain an IPv4 address assigned to this interface. If DHCPv4 is enabled on the interface, this property becomes read-only.", "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$", "readonly": false, "type": [ @@ -56,12 +57,12 @@ } ], "description": "This indicates how the address was determined.", - "longDescription": "The value of this property shall be the IP address origin for this network interface.", + "longDescription": "This property shall contain the IP address origin for this network interface.", "readonly": true }, "Gateway": { - "description": "This is the IPv4 gateway for this address.", - "longDescription": "The value of this property shall be the IPv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the IPv4 default gateway address, this property becomes read-only.", + "description": "The IPv4 gateway for this address.", + "longDescription": "This property shall contain the IPv4 default gateway address for this interface. If DHCPv4 is enabled on the interface and is configured to set the IPv4 default gateway address, this property becomes read-only.", "pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$", "readonly": false, "type": [ @@ -71,8 +72,8 @@ }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "Oem extension object.", - "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." }, "SubnetMask": { "anyOf": [ @@ -83,8 +84,8 @@ "type": "null" } ], - "description": "This is the IPv4 Subnet mask.", - "longDescription": "The value of this property shall be the IPv4 subnet mask for this address. If DHCPv4 is enabled on the interface, this property becomes read-only.", + "description": "The IPv4 subnet mask.", + "longDescription": "This property shall contain the IPv4 subnet mask for this address. If DHCPv4 is enabled on the interface, this property becomes read-only.", "readonly": false } }, @@ -98,19 +99,19 @@ "IPv4LinkLocal" ], "enumDescriptions": { - "BOOTP": "Address is provided by a BOOTP service.", - "DHCP": "Address is provided by a DHCPv4 service.", - "IPv4LinkLocal": "Address is valid only for this network segment (link).", - "Static": "A static address as configured by the user." + "BOOTP": "A BOOTP service-provided address.", + "DHCP": "A DHCPv4 service-provided address.", + "IPv4LinkLocal": "The address is valid for only this network segment, or link.", + "Static": "A user-configured static address." }, "type": "string" }, "IPv6Address": { "additionalProperties": false, - "description": "This type describes an IPv6 Address.", + "description": "This type describes an IPv6 address.", "longDescription": "This type shall describe an IPv6 address assigned to an interface.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -125,7 +126,7 @@ }, "properties": { "Address": { - "description": "This is the IPv6 Address.", + "description": "The IPv6 address.", "longDescription": "This property lists an IPv6 address that is currently assigned on this interface.", "readonly": false, "type": [ @@ -143,7 +144,7 @@ } ], "description": "This indicates how the address was determined.", - "longDescription": "The value of this property shall be the IPv6 address origin for this interface.", + "longDescription": "This property shall contain the IPv6 address origin for this interface.", "readonly": true }, "AddressState": { @@ -155,14 +156,14 @@ "type": "null" } ], - "description": "The current state of this address as defined in RFC 4862.", - "longDescription": "Preferred and Deprecated states follow the definitions given RFC4862 Section 5.5.4. An address is in the Tentative state while undergoing Duplicate Address Detection (DAD) per RFC4862 Section 5.4. The Failed state indicates a Static addresses which did not pass DAD. A Static address in the Failed state is not in use on the network stack, and corrective action will be needed to remedy this condition.", + "description": "The current RFC4862-defined state of this address.", + "longDescription": "This property shall contain the current RFC4862-defined state of this address. Preferred and Deprecated states follow the definitions in RFC4862, section 5.5.4. The Tentative state indicates that the address is undergoing Duplicate Address Detection (DAD), as defined in RFC4862, section 5.4. The Failed state indicates a static address that did not pass DAD. A static address in the Failed state is not in use on the network stack, and corrective action is required to remedy this condition.", "readonly": true }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "Oem extension object.", - "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." }, "PrefixLength": { "anyOf": [ @@ -173,8 +174,8 @@ "type": "null" } ], - "description": "This is the IPv6 Address Prefix Length.", - "longDescription": "The value of this property shall be the IPv6 address prefix length for this interface.", + "description": "The IPv6 address prefix Length.", + "longDescription": "This property shall contain the IPv6 address prefix length for this interface.", "readonly": true } }, @@ -188,19 +189,19 @@ "SLAAC" ], "enumDescriptions": { - "DHCPv6": "Address is provided by a DHCPv6 service.", - "LinkLocal": "Address is valid only for this network segment (link).", - "SLAAC": "Address is provided by a Stateless Address AutoConfiguration (SLAAC) service.", - "Static": "A static address as configured by the user." + "DHCPv6": "A DHCPv6 service-provided address.", + "LinkLocal": "The address is valid for only this network segment, or link.", + "SLAAC": "A stateless autoconfiguration (SLAAC) service-provided address.", + "Static": "A static user-configured address." }, "type": "string" }, "IPv6GatewayStaticAddress": { "additionalProperties": false, - "description": "This object represents a single IPv6 static address to be assigned on a network interface.", + "description": "This type represents a single IPv6 static address to be assigned on a network interface.", "longDescription": "This type shall represent a single IPv6 static address to be assigned on a network interface.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -221,12 +222,14 @@ "type": [ "string", "null" - ] + ], + "versionAdded": "v1_1_0" }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "Oem extension object.", - "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements.", + "versionAdded": "v1_1_0" }, "PrefixLength": { "anyOf": [ @@ -237,9 +240,10 @@ "type": "null" } ], - "description": "The Prefix Length of this IPv6 address.", - "longDescription": "Provides the IPv6 network prefix length in bits for this address.", - "readonly": false + "description": "The IPv6 network prefix length, in bits, for this address.", + "longDescription": "Provides the IPv6 network prefix length, in bits, for this address.", + "readonly": false, + "versionAdded": "v1_1_0" } }, "required": [ @@ -249,10 +253,10 @@ }, "IPv6StaticAddress": { "additionalProperties": false, - "description": "This object represents a single IPv6 static address to be assigned on a network interface.", + "description": "This type represents a single IPv6 static address to be assigned on a network interface.", "longDescription": "This type shall represent a single IPv6 static address to be assigned on a network interface.", "patternProperties": { - "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": { + "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_]*$": { "description": "This property shall specify a valid odata or Redfish property.", "type": [ "array", @@ -277,8 +281,8 @@ }, "Oem": { "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem", - "description": "Oem extension object.", - "longDescription": "This object represents the Oem property. All values for resources described by this schema shall comply to the requirements as described in the Redfish specification." + "description": "The OEM extension property.", + "longDescription": "This property shall contain the OEM extensions. All values for properties contained in this object shall conform to the Redfish Specification-described requirements." }, "PrefixLength": { "anyOf": [ @@ -289,8 +293,8 @@ "type": "null" } ], - "description": "The Prefix Length of this IPv6 address.", - "longDescription": "Provides the IPv6 network prefix length in bits for this address.", + "description": "The prefix length, in bits, of this IPv6 address.", + "longDescription": "This property shall contain the IPv6 network prefix length, in bits, for this address.", "readonly": false } }, @@ -311,5 +315,6 @@ } }, "owningEntity": "DMTF", - "title": "#IPAddresses.v1_1_0" + "release": "2018.2", + "title": "#IPAddresses.v1_1_1" }
\ No newline at end of file |