xref: /openbmc/bmcweb/features/redfish/schema/dmtf/json-schema/AllowDeny.v1_0_3.json (revision f2a8e57ede74a8252100b2281e3f4d170aa69391)

{
    "$id": "http://redfish.dmtf.org/schemas/v1/AllowDeny.v1_0_3.json",
    "$ref": "#/definitions/AllowDeny",
    "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
    "copyright": "Copyright 2014-2024 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
    "definitions": {
        "Actions": {
            "additionalProperties": false,
            "description": "The available actions for this resource.",
            "longDescription": "This type shall contain the available actions for this resource.",
            "patternProperties": {
                "^([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",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "Oem": {
                    "$ref": "#/definitions/OemActions",
                    "description": "The available OEM-specific actions for this resource.",
                    "longDescription": "This property shall contain the available OEM-specific actions for this resource."
                }
            },
            "type": "object"
        },
        "AllowDeny": {
            "additionalProperties": false,
            "description": "The `AllowDeny` schema represents a set of allow or deny configurations.",
            "longDescription": "This resource shall represent an AllowDeny resource in a Redfish implementation.",
            "patternProperties": {
                "^([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",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {
                "@odata.context": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/context"
                },
                "@odata.etag": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/etag"
                },
                "@odata.id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/id"
                },
                "@odata.type": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/odata-v4.json#/definitions/type"
                },
                "Actions": {
                    "$ref": "#/definitions/Actions",
                    "description": "The available actions for this resource.",
                    "longDescription": "This property shall contain the available actions for this resource."
                },
                "AllowType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/AllowType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Indicates the type of permission.",
                    "longDescription": "This property shall indicate the type of permission.",
                    "readonly": false
                },
                "Description": {
                    "anyOf": [
                        {
                            "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "readonly": true
                },
                "DestinationPortLower": {
                    "description": "The TCP, UDP, or other destination port to which this rule begins application, inclusive.",
                    "longDescription": "This property shall contain the TCP, UDP, or other destination port to which this rule begins application, inclusive.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "DestinationPortUpper": {
                    "description": "The TCP, UDP, or other destination port to which this rule ends application, inclusive.",
                    "longDescription": "This property shall contain the TCP, UDP, or other destination port to which this rule ends application, inclusive.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "Direction": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/DataDirection"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "Indicates the direction of the data to which this permission applies.",
                    "longDescription": "This value shall indicate the direction of the data to which this permission applies for this network device function.",
                    "readonly": false
                },
                "IANAProtocolNumber": {
                    "description": "The IANA protocol number to which this permission applies.  For TCP, this is `6`.  For UDP, this is `17`.",
                    "longDescription": "This property shall contain the IANA protocol number to which this permission applies.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "IPAddressLower": {
                    "description": "The lower IP address to which this permission applies.",
                    "longDescription": "This property shall contain the lower IP address to which this permission applies.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "IPAddressType": {
                    "anyOf": [
                        {
                            "$ref": "#/definitions/IPAddressType"
                        },
                        {
                            "type": "null"
                        }
                    ],
                    "description": "The type of IP address populated in the `IPAddressLower` and `IPAddressUpper` properties.",
                    "longDescription": "This property shall contain the type of IP address populated in the `IPAddressLower` and `IPAddressUpper` properties.  Services shall not permit mixing IPv6 and IPv4 addresses on the same resource.",
                    "readonly": false
                },
                "IPAddressUpper": {
                    "description": "The upper IP address to which this permission applies.",
                    "longDescription": "This property shall contain the upper IP address to which this permission applies.",
                    "readonly": false,
                    "type": [
                        "string",
                        "null"
                    ]
                },
                "Id": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
                    "readonly": true
                },
                "Name": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
                    "readonly": true
                },
                "Oem": {
                    "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
                    "description": "The OEM extension property.",
                    "longDescription": "This property shall contain the OEM extensions.  All values for properties that this object contains shall conform to the Redfish Specification-described requirements."
                },
                "SourcePortLower": {
                    "description": "The TCP, UDP, or other source port to which this rule begins application, inclusive.",
                    "longDescription": "This property shall contain the TCP, UDP, or other source port to which this rule begins application, inclusive.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "SourcePortUpper": {
                    "description": "The TCP, UDP or other source port to which this rule ends application, inclusive.",
                    "longDescription": "This property shall contain the TCP, UDP, or other source port to which this rule ends application, inclusive.",
                    "readonly": false,
                    "type": [
                        "integer",
                        "null"
                    ]
                },
                "StatefulSession": {
                    "description": "Indicates if this is a permission that only applies to stateful connections.",
                    "longDescription": "This property shall indicate if this permission only applies to stateful connections, which are those using SYN, ACK, and FIN.",
                    "readonly": false,
                    "type": [
                        "boolean",
                        "null"
                    ]
                }
            },
            "required": [
                "@odata.id",
                "@odata.type",
                "Id",
                "Name"
            ],
            "type": "object"
        },
        "AllowType": {
            "enum": [
                "Allow",
                "Deny"
            ],
            "enumDescriptions": {
                "Allow": "Indicates that traffic that matches the criteria in this resource is permitted.",
                "Deny": "Indicates that traffic that matches the criteria in this resource is not permitted."
            },
            "type": "string"
        },
        "DataDirection": {
            "enum": [
                "Ingress",
                "Egress"
            ],
            "enumDescriptions": {
                "Egress": "Indicates that this limit is enforced on packets and bytes transmitted by the network device function.",
                "Ingress": "Indicates that this limit is enforced on packets and bytes received by the network device function."
            },
            "type": "string"
        },
        "IPAddressType": {
            "enum": [
                "IPv4",
                "IPv6"
            ],
            "enumDescriptions": {
                "IPv4": "IPv4 addressing is used for all IP-fields in this object.",
                "IPv6": "IPv6 addressing is used for all IP-fields in this object."
            },
            "type": "string"
        },
        "OemActions": {
            "additionalProperties": true,
            "description": "The available OEM-specific actions for this resource.",
            "longDescription": "This type shall contain the available OEM-specific actions for this resource.",
            "patternProperties": {
                "^([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",
                        "boolean",
                        "integer",
                        "number",
                        "null",
                        "object",
                        "string"
                    ]
                }
            },
            "properties": {},
            "type": "object"
        }
    },
    "language": "en",
    "owningEntity": "DMTF",
    "release": "2021.2",
    "title": "#AllowDeny.v1_0_3.AllowDeny"
}