category: Network Security provider: HPE sectionorder: - Connect - Collect commonfields: id: HPEArubaClearPass version: -1 configuration: - display: Your server URL (e.g., https://example.net) name: url required: true type: 0 section: Connect - additionalinfo: HPE Aruba ClearPass client identifier. display: Client ID name: client_id type: 0 hidden: true required: false section: Connect - additionalinfo: HPE Aruba ClearPass client secret. display: Client Secret name: client_secret type: 4 hidden: true required: false section: Connect - display: Client ID name: client_id_creds type: 9 displaypassword: Client Secret required: false section: Connect - display: Trust any certificate (not secure) name: insecure type: 8 required: false section: Connect - display: Use system proxy settings name: proxy type: 8 section: Connect required: false description: Aruba ClearPass Policy Manager provides role and device-based network access control for employees, contractors, and guests across any multi-vendor wired, wireless, and VPN infrastructure. display: HPE Aruba ClearPass name: HPEArubaClearPass script: commands: - arguments: - description: MAC address of the required endpoint. If not given, all the endpoints will be returned. name: mac_address - auto: PREDEFINED description: Status of the required endpoint. Possible values- Known, Unknown, Disabled. name: status predefined: - Known - Unknown - Disabled - description: Zero based offset to start from. Default is 0. name: offset - description: Maximum number of items to return in the range of 1 – 1000. Default is 25. name: limit description: Get a list of endpoints. An endpoint device is an Internet-capable hardware device on a TCP/IP network (e.g. laptops, smart phones, tablets, etc.) name: aruba-clearpass-endpoints-list outputs: - contextPath: HPEArubaClearPass.Endpoints.id description: The ID of the endpoint. type: Number - contextPath: HPEArubaClearPass.Endpoints.mac_address description: The MAC address of the endpoint. type: string - contextPath: HPEArubaClearPass.Endpoints.description description: The description of the endpoint. type: string - contextPath: HPEArubaClearPass.Endpoints.status description: The status of the endpoint. type: string - contextPath: HPEArubaClearPass.Endpoints.device_insight_tags description: List of Device Insight Tags. type: Unknown - contextPath: HPEArubaClearPass.Endpoints.attributes description: Additional attributes (key/value pairs) that may be stored with the endpoint. type: Unknown - arguments: - description: Numeric ID of the endpoint. name: endpoint_id required: true - description: MAC address of the endpoint to be set. If not given, all the endpoints will be returned. name: mac_address - auto: PREDEFINED description: Status of the endpoint to be set. Can be Known/Unknown/Disabled. name: status predefined: - Known - Unknown - Disabled - description: Description of the endpoint to be set. name: description - description: A comma-seperated list of Device Insight Tags. isArray: true name: device_insight_tags - description: 'Additional attributes (key/value pairs) that may be stored with the endpoint. For example: [{"demisto_test": "aaaaa"},{"test":"good"}].' isArray: true name: attributes description: Updates some fields of an endpoint. name: aruba-clearpass-endpoint-update outputs: - contextPath: HPEArubaClearPass.Endpoints.id description: The ID of the endpoint. type: Number - contextPath: HPEArubaClearPass.Endpoints.mac_address description: The MAC Address of the endpoint. type: string - contextPath: HPEArubaClearPass.Endpoints.description description: The description of the endpoint. type: string - contextPath: HPEArubaClearPass.Endpoints.status description: The status of the endpoint. type: string - contextPath: HPEArubaClearPass.Endpoints.device_insight_tags description: List of Device Insight Tags. type: Unknown - contextPath: HPEArubaClearPass.Endpoints.attributes description: Additional attributes (key/value pairs) may be stored with the endpoint. type: Unknown - arguments: - description: Numeric ID of the required attribute. name: attribute_id - description: Name of the required attribute. name: name - auto: PREDEFINED description: Entity name of the required attribute. Can be Device/LocalUser/GuestUser/Endpoint/Onboard. name: entity_name predefined: - Device - LocalUser - GuestUser - Endpoint - Onboard - description: Zero-based offset to start from. Default is 0. name: offset - description: Maximum number of items to return in the range of 1 – 1000. Default is 25. name: limit description: Get a list of attributes. Attributes allows you to specify unique sets of criteria for local users, guest users, endpoints, and devices. If no arguments were given, all of the attributes will be displayed. name: aruba-clearpass-attributes-list outputs: - contextPath: HPEArubaClearPass.Attributes.id description: The ID of the attribute. type: Number - contextPath: HPEArubaClearPass.Attributes.name description: The name of the attribute. type: string - contextPath: HPEArubaClearPass.Attributes.entity_name description: The entity name of the attribute. type: string - contextPath: HPEArubaClearPass.Attributes.data_type description: The data type of the attribute (can be one of the following - Boolean, Date, Day, IPv4Address, Integer32, List, MACAddress, String, Text, Time, TimeOfDay). type: string - contextPath: HPEArubaClearPass.Attributes.mandatory description: Whether this attribute mandatory for the given entity_name. type: Boolean - contextPath: HPEArubaClearPass.Attributes.default_value description: Default value of the attribute. type: Unknown - contextPath: HPEArubaClearPass.Attributes.allow_multiple description: Whether to allow multiple values of the attribute with data type String only (API limitation). type: Boolean - contextPath: HPEArubaClearPass.Attributes.allowed_value description: The allowed value for attribute with data type List (e.g., example1,example2,example3). type: Unknown - arguments: - description: Name of the attribute to be set. name: name required: true - auto: PREDEFINED description: Entity name of the attribute to be set. Can be Device/LocalUser/GuestUser/Endpoint/Onboard. name: entity_name predefined: - Device - LocalUser - GuestUser - Endpoint - Onboard required: true - auto: PREDEFINED description: Data Type of the attribute to be set. Can be one of the following - Boolean,Date,Day,IPv4Address,Integer32,List,MACAddress,String,Text,Time,TimeOfDay. name: data_type predefined: - Boolean - Date - Day - IPv4Address - Integer32 - List - MACAddress - String - Text - Time - TimeOfDay required: true - description: Whether to make this attribute mandatory for the given entity_name. Default is False. auto: PREDEFINED name: mandatory predefined: - 'True' - 'False' - description: Default value of the attribute. Default is an empty string. name: default_value - description: Whether to allow multiple values of the attribute with data type String only (API limitation). Default is False. name: allow_multiple auto: PREDEFINED predefined: - 'True' - 'False' - description: Possible value for attribute with data type List only (API limitation) (e.g., example1,example2,example3). Default is an empty string. name: allowed_value description: Create a new attribute. name: aruba-clearpass-attribute-create outputs: - contextPath: HPEArubaClearPass.Attributes.id description: The ID of the attribute. type: Number - contextPath: HPEArubaClearPass.Attributes.name description: The name of the attribute. type: string - contextPath: HPEArubaClearPass.Attributes.entity_name description: The entity name of the attribute. type: string - contextPath: HPEArubaClearPass.Attributes.data_type description: The data type of the attribute (can be one of the following - Boolean, Date, Day, IPv4Address, Integer32, List, MACAddress, String, Text, Time, TimeOfDay). type: string - contextPath: HPEArubaClearPass.Attributes.mandatory description: Whether this attribute is mandatory for the given entity_name. type: Boolean - contextPath: HPEArubaClearPass.Attributes.default_value. description: Default value of the attribute. type: Unknown - contextPath: HPEArubaClearPass.Attributes.allow_multiple description: Whether to allow multiple values of the attribute with data type String only (API limitation). type: Boolean - contextPath: HPEArubaClearPass.Attributes.allowed_value description: The allowed value for attribute with data type List (e.g., example1,example2,example3). type: Unknown - arguments: - description: Numeric ID of the attribute to be updated. name: attribute_id required: true - description: Name of the attribute to be set. name: name - auto: PREDEFINED description: Entity Name of the attribute to be set. Can be Device/LocalUser/GuestUser/Endpoint/Onboard. name: entity_name predefined: - Device - LocalUser - GuestUser - Endpoint - Onboard - auto: PREDEFINED description: Data type of the attribute to be set. Can be one of the following - Boolean,Date,Day,IPv4Address,Integer32,List,MACAddress,String,Text,Time,TimeOfDay. name: data_type predefined: - Boolean - Date - Day - IPv4Address - Integer32 - List - MACAddress - String - Text - Time - TimeOfDay - description: Whether to make this attribute mandatory for the given entity_name. Default is False. auto: PREDEFINED name: mandatory predefined: - 'True' - 'False' - description: Default value of the attribute. Default is an empty string. name: default_value - description: Whether to allow multiple values of the attribute with data type String only (API limitation). Default is False. name: allow_multiple auto: PREDEFINED predefined: - 'True' - 'False' - description: Possible value for attribute with data type List only (API limitation) (e.g., example1,example2,example3). Default is an empty string. name: allowed_value description: Update some fields of an attribute by the attribute's ID. name: aruba-clearpass-attribute-update outputs: - contextPath: HPEArubaClearPass.Attributes.id description: The ID of the attribute. type: Number - contextPath: HPEArubaClearPass.Attributes.name description: The name of the attribute. type: string - contextPath: HPEArubaClearPass.Attributes.entity_name description: The entity name of the attribute. type: string - contextPath: HPEArubaClearPass.Attributes.data_type description: The data type of the attribute (can be one of the following - Boolean, Date, Day, IPv4Address, Integer32, List, MACAddress, String, Text, Time, TimeOfDay). type: string - contextPath: HPEArubaClearPass.Attributes.mandatory description: Whether this attribute mandatory is for the given entity_name. type: Boolean - contextPath: HPEArubaClearPass.Attributes.default_value. description: Default value of the attribute. type: Unknown - contextPath: HPEArubaClearPass.Attributes.allow_multiple description: Whether to allow multiple values of the attribute with data type String only (API limitation). type: Boolean - contextPath: HPEArubaClearPass.Attributes.allowed_value description: The allowed value for attribute with data type List (e.g., example1,example2,example3). type: Unknown - arguments: - description: Numeric ID of the attribute. name: attribute_id required: true description: Delete an attribute. name: aruba-clearpass-attribute-delete - arguments: - description: ID of the active session. name: session_id - description: IP address of the client. name: device_ip - description: MAC address of the client device. name: device_mac_address - description: The visitor’s phone number. name: visitor_phone - description: Maximum number of items to return in the range of 1 – 1000. Default is 25. name: limit description: Get a list of active sessions. name: aruba-clearpass-active-sessions-list outputs: - contextPath: HPEArubaClearPass.Sessions.ID description: ID of the active session. type: String - contextPath: HPEArubaClearPass.Sessions.Device_IP description: IP address of the client. type: String - contextPath: HPEArubaClearPass.Sessions.Device_mac_address description: MAC address of the client device. type: String - contextPath: HPEArubaClearPass.Sessions.state description: The current state of the session (active, stale, closed). type: String - contextPath: HPEArubaClearPass.Sessions.Visitor_phone description: The visitor’s phone number. type: String - arguments: - description: ID of the session to disconnect. name: session_id required: true description: Disconnect active session. name: aruba-clearpass-active-session-disconnect outputs: - contextPath: HPEArubaClearPass.Sessions.Error_code description: Error status code of the response (non-zero if a problem occurred). type: Number - contextPath: HPEArubaClearPass.Sessions.Response_message description: Describes the result of the disconnected operation. type: String dockerimage: demisto/python3:3.12.13.10116658 script: '-' subtype: python3 type: python tests: - HPEArubaClearPass_TestPlaybook fromversion: 6.0.0