PolicyHostSwitchProfileListRequestParameters (type)

{
  "additionalProperties": false, 
  "extends": {
    "$ref": "PolicyListRequestParameters
  }, 
  "id": "PolicyHostSwitchProfileListRequestParameters", 
  "module_id": "PolicyBaseHostSwitchProfile", 
  "properties": {
    "cursor": {
      "readonly": false, 
      "title": "Opaque cursor to be used for getting next page of records (supplied by current result page)", 
      "type": "string"
    }, 
    "deployment_type": {
      "$ref": "EdgeDeploymentType, 
      "description": "If the node_type is specified, then deployment_type may be specified to filter uplink profiles applicable to only PHYSICAL_MACHINE or VIRTUAL_MACHINE deployments of these nodes.", 
      "required": false, 
      "title": "Deployment type of EdgeNode or PublicCloudGatewayNode"
    }, 
    "hostswitch_profile_type": {
      "$ref": "PolicyHostSwitchProfileType, 
      "required": false, 
      "title": "Type of host switch profile"
    }, 
    "include_mark_for_delete_objects": {
      "default": false, 
      "description": "If true, resources that are marked for deletion will be included in the results. By default, these resources are not included.", 
      "required": false, 
      "title": "Include objects that are marked for deletion in results", 
      "type": "boolean"
    }, 
    "include_system_owned": {
      "default": false, 
      "required": false, 
      "title": "Whether the list result contains system resources", 
      "type": "boolean"
    }, 
    "included_fields": {
      "description": "Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.", 
      "title": "Comma separated list of fields that should be included in query result", 
      "type": "string"
    }, 
    "max_active_uplink_count": {
      "description": "Filter uplink profiles whose number of active uplinks in teaming policy is less than or equal to max_active_uplink_count.", 
      "required": false, 
      "title": "Filter uplink profiles by number of active links in teaming policy.", 
      "type": "int"
    }, 
    "node_type": {
      "description": "The fabric node type is the resource_type of the Node such as EdgeNode and PublicCloudGatewayNode. If a fabric node type is given, uplink profiles that apply for nodes of the given type will be returned.", 
      "enum": [
        "EdgeNode", 
        "PublicCloudGatewayNode"
      ], 
      "required": false, 
      "title": "Fabric node type for which uplink profiles are to be listed", 
      "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"
    }, 
    "uplink_teaming_policy_name": {
      "description": "If populated, only UplinkHostSwitchProfiles with the specified uplink teaming policy name are returned. Otherwise, any HostSwitchProfile can be returned.", 
      "required": false, 
      "title": "The host switch profile's uplink teaming policy name", 
      "type": "string"
    }
  }, 
  "title": "HostSwitchProfile List Request Parameters", 
  "type": "object"
}