From 91f32748e0577aaa8d402aba0c005bd3cb1b95e6 Mon Sep 17 00:00:00 2001 From: jazzyj123 <76889039+jazzyj123@users.noreply.github.com> Date: Mon, 6 Nov 2023 12:37:07 +0000 Subject: [PATCH] api files updated to v1.0.4 Updated API files based on ClearPass v6.11.5 --- pyclearpass/api_apioperations.py | 4 + pyclearpass/api_certificateauthority.py | 18 + pyclearpass/api_endpointvisibility.py | 106 +- pyclearpass/api_enforcementprofile.py | 5154 ++++++++++-------- pyclearpass/api_globalserverconfiguration.py | 112 +- pyclearpass/api_guestactions.py | 6 + pyclearpass/api_guestconfiguration.py | 52 +- pyclearpass/api_identities.py | 66 + pyclearpass/api_insight.py | 50 +- pyclearpass/api_integrations.py | 72 + pyclearpass/api_localserverconfiguration.py | 18 +- pyclearpass/api_logs.py | 2 + pyclearpass/api_platformcertificates.py | 20 + pyclearpass/api_policyelements.py | 272 +- pyclearpass/api_sessioncontrol.py | 20 + pyclearpass/api_toolsandutilities.py | 8 + 16 files changed, 3517 insertions(+), 2463 deletions(-) diff --git a/pyclearpass/api_apioperations.py b/pyclearpass/api_apioperations.py index 6380053..3f10086 100644 --- a/pyclearpass/api_apioperations.py +++ b/pyclearpass/api_apioperations.py @@ -17,6 +17,7 @@ def new_oauth(self, body=({})): Required Body Parameters:['grant_type', 'client_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "grant_type" : "", #OAuth2 authentication method. Object Type: string "client_id" : "", #Client ID defined in API Clients. Object Type: string @@ -25,6 +26,7 @@ def new_oauth(self, body=({})): "password" : "", #Password for authentication, required for grant_type "password". Object Type: string "scope" : "", #Scope of the access request. Object Type: string "refresh_token" : "", #Refresh token issued to the client, required for grant_type "refresh_token". Object Type: string + } """ url_path = "/oauth" @@ -49,10 +51,12 @@ def new_oauth_me(self, body=({})): Required Body Parameters:['info', 'name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "info" : "", #Defaults to the operator profile name. Object Type: string "name" : "", #Defaults to the authenticated username. Object Type: string "..." : "", #Additional properties may be returned for grant_type "password" if corresponding properties are defined in the OAuth API enforcement profile. Object Type: string + } """ url_path = "/oauth/me" diff --git a/pyclearpass/api_certificateauthority.py b/pyclearpass/api_certificateauthority.py index e2b7bed..3e9f55a 100644 --- a/pyclearpass/api_certificateauthority.py +++ b/pyclearpass/api_certificateauthority.py @@ -79,12 +79,14 @@ def new_certificate_by_cert_id_export(self, cert_id="", body=({})): Required Body Parameters:['export_format'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "export_format" : "", #Select the file format for the exported item. Object Type: string "include_chain" : False, #Select this option to include the certificates for the CA and any intermediate certificate authorities. Object Type: boolean "include_ca" : "", #Select which certificate authorities to include.. Object Type: string "export_password" : "", #Passphrase to protect the PKCS#12 file. Object Type: string "export_password2" : "", #Re-enter the passphrase. Object Type: string + } """ url_path = "/certificate/{cert_id}/export" @@ -104,6 +106,7 @@ def new_certificate_import(self, body=({})): Required Body Parameters:['type', 'certificate_file', 'certificate_file_encoding'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "ca_id" : 0, #Numeric ID of the certificate authority. Object Type: integer "type" : "", #Type of certificate to import. Object Type: string @@ -112,6 +115,7 @@ def new_certificate_import(self, body=({})): "key_file" : "", #Contents of private key to import. Object Type: string "key_file_encoding" : "", #Encoding used for 'key_file' parameter. Object Type: string "key_passphrase" : "", #Enter the passphrase that was used to encrypt the private key. If the private key is not encrypted, leave this field blank. Object Type: string + } """ url_path = "/certificate/import" @@ -128,6 +132,7 @@ def new_certificate_new(self, body=({})): Required Body Parameters:['ca_id', 'cert_type', 'country', 'state', 'locality', 'organization', 'common_name', 'email_address', 'key_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "ca_id" : 0, #Select the certificate authority that will be used to sign this request. Object Type: integer "cert_type" : "", #Select the type of certificate to create from this signing request. Object Type: string @@ -154,6 +159,7 @@ def new_certificate_new(self, body=({})): "device_name" : "", #Device name to store in certificate subject alternative name. Object Type: string "custom_field" : "", #Custom fields to store in certificate subject alternative name. Object Type: string "user_email_address" : "", #User’s email address to store in certificate subject alternative name. Object Type: string + } """ url_path = "/certificate/new" @@ -171,8 +177,10 @@ def new_certificate_by_cert_id_reject(self, cert_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "confirm_reject" : False, #Select this checkbox to confirm the rejection of this request. Object Type: boolean + } """ url_path = "/certificate/{cert_id}/reject" @@ -192,6 +200,7 @@ def new_certificate_request(self, body=({})): Required Body Parameters:['ca_id', 'file_csr', 'cert_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "ca_id" : 0, #Select the certificate authority that will be used to sign this request. Object Type: integer "file_csr_encoding" : "", #Encoding used for 'file_csr' parameter. Object Type: string @@ -199,6 +208,7 @@ def new_certificate_request(self, body=({})): "cert_type" : "", #Select the type of certificate to create from this signing request. Object Type: string "issue_cert" : False, #To modify the subject of the certificate before signing, do not select this checkbox. Object Type: boolean "days" : "", #The number of days before the certificate will expire. Object Type: string + } """ url_path = "/certificate/request" @@ -216,9 +226,11 @@ def new_certificate_by_cert_id_revoke(self, cert_id="", body=({})): Required Body Parameters:['ca_id', 'confirm_revoke'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "ca_id" : 0, #Numeric ID of the certificate authority. Object Type: integer "confirm_revoke" : False, #Select this checkbox to confirm the certificate revocation. Object Type: boolean + } """ url_path = "/certificate/{cert_id}/revoke" @@ -239,6 +251,7 @@ def new_certificate_by_cert_id_sign(self, cert_id="", body=({})): Required Body Parameters:['ca_id', 'days', 'confirm_sign'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "ca_id" : 0, #Numeric ID of the certificate authority. Object Type: integer "days" : 0, #The number of days before the certificate will expire. Object Type: integer @@ -251,6 +264,7 @@ def new_certificate_by_cert_id_sign(self, cert_id="", body=({})): "field":"", #Field within the subject alt name. Object Type: string "value":"", #Value of the field. Object Type: string }], #If specified, a list of field/value pairs for the subjectAltName of the issued certificate. Object Type: array + } """ url_path = "/certificate/{cert_id}/sign" @@ -306,6 +320,7 @@ def update_onboard_device_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric ID of the device. Object Type: integer "status" : "", #Determines whether the device is able to enroll and access the network. Object Type: string @@ -324,6 +339,7 @@ def update_onboard_device_by_id(self, id="", body=({})): "expanded_type" : "", #Marketing name for the product. Object Type: string "mdm_managed" : "", #Mobile device management (MDM) vendor name, if an endpoint context server reports the device as managed. Object Type: string "device_identifier" : "", #Unique identifier string . Object Type: string + } """ url_path = "/onboard/device/{id}" @@ -404,11 +420,13 @@ def update_user_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric ID of the user. Object Type: integer "status" : "", #Determines whether the user can enroll devices. Object Type: string "username" : "", #Username of the user. Object Type: string "device_count" : "", #Number of devices enrolled by this user. Object Type: string + } """ url_path = "/user/{id}" diff --git a/pyclearpass/api_endpointvisibility.py b/pyclearpass/api_endpointvisibility.py index ab9b44c..f457142 100644 --- a/pyclearpass/api_endpointvisibility.py +++ b/pyclearpass/api_endpointvisibility.py @@ -25,6 +25,7 @@ def new_agentless_onguard_settings(self, body=({})): Required Body Parameters:['name', 'client_os', 'working_dir', 'action', 'servers', 'download_url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Setting. Object Type: string "description" : "", #Description of Agentless OnGuard Setting. Object Type: string @@ -39,6 +40,7 @@ def new_agentless_onguard_settings(self, body=({})): "override_checksum" : False, #Override checksum fields (default=false). Object Type: boolean "checksums_32" : False, #SHA256 checksums of 32-bit Agentless OnGuard Wrapper EXEs. Object Type: array "checksums_64" : False, #SHA256 checksums of 64-bit Agentless OnGuard Wrapper EXEs. Object Type: array + } """ url_path = "/agentless-onguard/settings" @@ -69,6 +71,7 @@ def update_agentless_onguard_settings_by_settings_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Setting. Object Type: string "description" : "", #Description of Agentless OnGuard Setting. Object Type: string @@ -83,6 +86,7 @@ def update_agentless_onguard_settings_by_settings_id( "override_checksum" : False, #Override checksum fields (default=false). Object Type: boolean "checksums_32" : False, #SHA256 checksums of 32-bit Agentless OnGuard Wrapper EXEs. Object Type: array "checksums_64" : False, #SHA256 checksums of 64-bit Agentless OnGuard Wrapper EXEs. Object Type: array + } """ url_path = "/agentless-onguard/settings/{settings_id}" @@ -104,6 +108,7 @@ def replace_agentless_onguard_settings_by_settings_id( Required Body Parameters:['name', 'client_os', 'working_dir', 'action', 'servers', 'download_url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Setting. Object Type: string "description" : "", #Description of Agentless OnGuard Setting. Object Type: string @@ -118,6 +123,7 @@ def replace_agentless_onguard_settings_by_settings_id( "override_checksum" : False, #Override checksum fields (default=false). Object Type: boolean "checksums_32" : False, #SHA256 checksums of 32-bit Agentless OnGuard Wrapper EXEs. Object Type: array "checksums_64" : False, #SHA256 checksums of 64-bit Agentless OnGuard Wrapper EXEs. Object Type: array + } """ url_path = "/agentless-onguard/settings/{settings_id}" @@ -161,6 +167,7 @@ def update_agentless_onguard_settings_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Setting. Object Type: string "description" : "", #Description of Agentless OnGuard Setting. Object Type: string @@ -175,6 +182,7 @@ def update_agentless_onguard_settings_name_by_name(self, name="", body=({})): "override_checksum" : False, #Override checksum fields (default=false). Object Type: boolean "checksums_32" : False, #SHA256 checksums of 32-bit Agentless OnGuard Wrapper EXEs. Object Type: array "checksums_64" : False, #SHA256 checksums of 64-bit Agentless OnGuard Wrapper EXEs. Object Type: array + } """ url_path = "/agentless-onguard/settings/name/{name}" @@ -194,6 +202,7 @@ def replace_agentless_onguard_settings_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'client_os', 'working_dir', 'action', 'servers', 'download_url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Setting. Object Type: string "description" : "", #Description of Agentless OnGuard Setting. Object Type: string @@ -208,6 +217,7 @@ def replace_agentless_onguard_settings_name_by_name(self, name="", body=({})): "override_checksum" : False, #Override checksum fields (default=false). Object Type: boolean "checksums_32" : False, #SHA256 checksums of 32-bit Agentless OnGuard Wrapper EXEs. Object Type: array "checksums_64" : False, #SHA256 checksums of 64-bit Agentless OnGuard Wrapper EXEs. Object Type: array + } """ url_path = "/agentless-onguard/settings/name/{name}" @@ -262,6 +272,7 @@ def new_agentless_onguard_subnet_mapping(self, body=({})): Required Body Parameters:['name', 'client_subnets', 'zone', 'client_scan_setting'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Subnet Mapping. Object Type: string "client_subnets" : "", #IP subnets used for selecting clients. Object Type: array @@ -271,6 +282,7 @@ def new_agentless_onguard_subnet_mapping(self, body=({})): "agentless_onguard_setting_linux" : "", #Name of Agentless OnGuard setting for Linux for the specified subnet and zone. To unset, use empty string. Object Type: string "client_scan_setting" : "", #Clients to be scanned in the subnet. Object Type: string "enabled" : False, #Enable Clearpass server to process clients in the subnet and run Agentless OnGuard (default=true). Object Type: boolean + } """ url_path = "/agentless-onguard/subnet-mapping" @@ -303,6 +315,7 @@ def update_agentless_onguard_subnet_mapping_by_subnet_mapping_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Subnet Mapping. Object Type: string "client_subnets" : "", #IP subnets used for selecting clients. Object Type: array @@ -312,6 +325,7 @@ def update_agentless_onguard_subnet_mapping_by_subnet_mapping_id( "agentless_onguard_setting_linux" : "", #Name of Agentless OnGuard setting for Linux for the specified subnet and zone. To unset, use empty string. Object Type: string "client_scan_setting" : "", #Clients to be scanned in the subnet. Object Type: string "enabled" : False, #Enable Clearpass server to process clients in the subnet and run Agentless OnGuard (default=true). Object Type: boolean + } """ url_path = "/agentless-onguard/subnet-mapping/{subnet_mapping_id}" @@ -333,6 +347,7 @@ def replace_agentless_onguard_subnet_mapping_by_subnet_mapping_id( Required Body Parameters:['name', 'client_subnets', 'zone', 'client_scan_setting'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Subnet Mapping. Object Type: string "client_subnets" : "", #IP subnets used for selecting clients. Object Type: array @@ -342,6 +357,7 @@ def replace_agentless_onguard_subnet_mapping_by_subnet_mapping_id( "agentless_onguard_setting_linux" : "", #Name of Agentless OnGuard setting for Linux for the specified subnet and zone. To unset, use empty string. Object Type: string "client_scan_setting" : "", #Clients to be scanned in the subnet. Object Type: string "enabled" : False, #Enable Clearpass server to process clients in the subnet and run Agentless OnGuard (default=true). Object Type: boolean + } """ url_path = "/agentless-onguard/subnet-mapping/{subnet_mapping_id}" @@ -387,6 +403,7 @@ def update_agentless_onguard_subnet_mapping_name_by_name(self, name="", body=({} Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Subnet Mapping. Object Type: string "client_subnets" : "", #IP subnets used for selecting clients. Object Type: array @@ -396,6 +413,7 @@ def update_agentless_onguard_subnet_mapping_name_by_name(self, name="", body=({} "agentless_onguard_setting_linux" : "", #Name of Agentless OnGuard setting for Linux for the specified subnet and zone. To unset, use empty string. Object Type: string "client_scan_setting" : "", #Clients to be scanned in the subnet. Object Type: string "enabled" : False, #Enable Clearpass server to process clients in the subnet and run Agentless OnGuard (default=true). Object Type: boolean + } """ url_path = "/agentless-onguard/subnet-mapping/name/{name}" @@ -415,6 +433,7 @@ def replace_agentless_onguard_subnet_mapping_name_by_name(self, name="", body=({ Required Body Parameters:['name', 'client_subnets', 'zone', 'client_scan_setting'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Agentless OnGuard Subnet Mapping. Object Type: string "client_subnets" : "", #IP subnets used for selecting clients. Object Type: array @@ -424,6 +443,7 @@ def replace_agentless_onguard_subnet_mapping_name_by_name(self, name="", body=({ "agentless_onguard_setting_linux" : "", #Name of Agentless OnGuard setting for Linux for the specified subnet and zone. To unset, use empty string. Object Type: string "client_scan_setting" : "", #Clients to be scanned in the subnet. Object Type: string "enabled" : False, #Enable Clearpass server to process clients in the subnet and run Agentless OnGuard (default=true). Object Type: boolean + } """ url_path = "/agentless-onguard/subnet-mapping/name/{name}" @@ -507,20 +527,22 @@ def new_device_profiler_device_fingerprint(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "mac" : "", #MAC address of device. Object Type: string "ip" : "", #IP address of device. Object Type: string "hostname" : "", #Hostname of device. Object Type: string - "dhcp" : "" #variable unknown: , #DHCP attributes as JSON. Object Type: DHCPAttributes - "active_sync" : "" #variable unknown: , #Active Sync attributes as JSON. Object Type: ActiveSyncAttributes - "host" : "" #variable unknown: , #Host attributes as JSON. Object Type: HostAttributes - "snmp" : "" #variable unknown: , #SNMP attributes as JSON. Object Type: SNMPAttributes - "device" : "" #variable unknown: , #Device attributes as JSON. Object Type: DeviceAttributes - "tcp" : "" #variable unknown: , #TCP attributes as JSON. Object Type: TCPAttributes - "nmap" : "" #variable unknown: , #NMAP attributes as JSON. Object Type: NMAPAttributes - "ssh" : "" #variable unknown: , #SSH attributes as JSON. Object Type: SSHAttributes - "wmi" : "" #variable unknown: , #WMI attributes as JSON. Object Type: WMIAttributes - "ports" : "" #variable unknown: , #Port attributes as JSON. Object Type: PortsAttributes + "dhcp" : "", #DHCP attributes as JSON. Object Type: DHCPAttributes + "active_sync" : "", #Active Sync attributes as JSON. Object Type: ActiveSyncAttributes + "host" : "", #Host attributes as JSON. Object Type: HostAttributes + "snmp" : "", #SNMP attributes as JSON. Object Type: SNMPAttributes + "device" : "", #Device attributes as JSON. Object Type: DeviceAttributes + "tcp" : "", #TCP attributes as JSON. Object Type: TCPAttributes + "nmap" : "", #NMAP attributes as JSON. Object Type: NMAPAttributes + "ssh" : "", #SSH attributes as JSON. Object Type: SSHAttributes + "wmi" : "", #WMI attributes as JSON. Object Type: WMIAttributes + "ports" : "", #Port attributes as JSON. Object Type: PortsAttributes + } """ url_path = "/device-profiler/device-fingerprint" @@ -584,10 +606,12 @@ def new_fingerprint(self, body=({})): Required Body Parameters:['category', 'family', 'name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "category" : "", #Category name of the fingerprint. Object Type: string "family" : "", #Family name of the fingerprint. Object Type: string "name" : "", #Unique name of the fingerprint. Object Type: string + } """ url_path = "/fingerprint" @@ -616,10 +640,12 @@ def update_fingerprint_by_fingerprint_id(self, fingerprint_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "category" : "", #Category name of the fingerprint. Object Type: string "family" : "", #Family name of the fingerprint. Object Type: string "name" : "", #Unique name of the fingerprint. Object Type: string + } """ url_path = "/fingerprint/{fingerprint_id}" @@ -639,10 +665,12 @@ def replace_fingerprint_by_fingerprint_id(self, fingerprint_id="", body=({})): Required Body Parameters:['category', 'family', 'name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "category" : "", #Category name of the fingerprint. Object Type: string "family" : "", #Family name of the fingerprint. Object Type: string "name" : "", #Unique name of the fingerprint. Object Type: string + } """ url_path = "/fingerprint/{fingerprint_id}" @@ -694,10 +722,12 @@ def update_fingerprint_name_by_category_family_name( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "category" : "", #Category name of the fingerprint. Object Type: string "family" : "", #Family name of the fingerprint. Object Type: string "name" : "", #Unique name of the fingerprint. Object Type: string + } """ url_path = "/fingerprint/name/{category}/{family}/{name}" @@ -721,10 +751,12 @@ def replace_fingerprint_name_by_category_family_name( Required Body Parameters:['category', 'family', 'name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "category" : "", #Category name of the fingerprint. Object Type: string "family" : "", #Family name of the fingerprint. Object Type: string "name" : "", #Unique name of the fingerprint. Object Type: string + } """ url_path = "/fingerprint/name/{category}/{family}/{name}" @@ -783,6 +815,7 @@ def new_config_network_scan(self, body=({})): Required Body Parameters:['type', 'zone', 'seed_device_or_ip_subnet', 'scan_frequency'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "zone" : "", #Zone for the Network Scan. Object Type: string "type" : "", #Type of the Network Scan. Object Type: string @@ -794,6 +827,7 @@ def new_config_network_scan(self, body=({})): "depth" : 0, #Depth level for DISCOVERY Network Scan. Object Type: integer "probe_arp" : False, #Probe all ARP entries found (default=false for type="DISCOVERY", not applicable for type="SUBNET"). Object Type: boolean "enabled" : False, #Is Network Scan enabled? (default=true). Object Type: boolean + } """ url_path = "/config/network-scan" @@ -822,6 +856,7 @@ def update_config_network_scan_by_scan_id(self, scan_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "zone" : "", #Zone for the Network Scan. Object Type: string "type" : "", #Type of the Network Scan. Object Type: string @@ -833,6 +868,7 @@ def update_config_network_scan_by_scan_id(self, scan_id="", body=({})): "depth" : 0, #Depth level for DISCOVERY Network Scan. Object Type: integer "probe_arp" : False, #Probe all ARP entries found (default=false for type="DISCOVERY", not applicable for type="SUBNET"). Object Type: boolean "enabled" : False, #Is Network Scan enabled? (default=true). Object Type: boolean + } """ url_path = "/config/network-scan/{scan_id}" @@ -852,6 +888,7 @@ def replace_config_network_scan_by_scan_id(self, scan_id="", body=({})): Required Body Parameters:['type', 'zone', 'seed_device_or_ip_subnet', 'scan_frequency'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "zone" : "", #Zone for the Network Scan. Object Type: string "type" : "", #Type of the Network Scan. Object Type: string @@ -863,6 +900,7 @@ def replace_config_network_scan_by_scan_id(self, scan_id="", body=({})): "depth" : 0, #Depth level for DISCOVERY Network Scan. Object Type: integer "probe_arp" : False, #Probe all ARP entries found (default=false for type="DISCOVERY", not applicable for type="SUBNET"). Object Type: boolean "enabled" : False, #Is Network Scan enabled? (default=true). Object Type: boolean + } """ url_path = "/config/network-scan/{scan_id}" @@ -965,11 +1003,13 @@ def new_onguard_activity_message(self, body=({})): Required Body Parameters:['host_mac_list', 'message', 'is_broadcast'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_mac_list" : {}, #List of host MAC Address. Object Type: object "message" : "", #Message. Object Type: string "info_url" : "", #URL. Object Type: string "is_broadcast" : False, #Is a broadcast. Object Type: boolean + } """ url_path = "/onguard-activity/message" @@ -985,6 +1025,7 @@ def new_onguard_activity_notification(self, body=({})): Required Body Parameters:['host_mac_list', 'message', 'is_broadcast', 'action'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_mac_list" : {}, #List of host MAC Address. Object Type: object "message" : "", #Message. Object Type: string @@ -992,6 +1033,7 @@ def new_onguard_activity_notification(self, body=({})): "is_broadcast" : False, #Is a broadcast. Object Type: boolean "action" : "", #Action. Object Type: string "endpoint_status" : "", #Status of the endpoint. Object Type: string + } """ url_path = "/onguard-activity/notification" @@ -1031,6 +1073,7 @@ def new_onguard_custom_script(self, body=({})): Required Body Parameters:['name', 'os_type', 'script_type', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Custom Script. Object Type: string "description" : "", #Description of Custom Script. Object Type: string @@ -1041,6 +1084,7 @@ def new_onguard_custom_script(self, body=({})): "output_details" : {}, #Output Details of Custom Script, applicable only for health collection scripts (e.g. {"ExitCode":"Integer", "OutVar1":"Boolean", "OutVar2":"String"}). Object Type: object "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Custom Script, applicable only for health collection scripts. Object Type: string "rules" : {}, #List of Rules for Custom Script, applicable only for health collection scripts (e.g. [{"match_type":"OR","health_status":"Healthy","condition":[{"type":"Script","name":"ExitCode","oper":"EQUALS","value":"0"}]}]). Object Type: object + } """ url_path = "/onguard-custom-script" @@ -1073,6 +1117,7 @@ def update_onguard_custom_script_by_onguard_custom_script_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Custom Script. Object Type: string "description" : "", #Description of Custom Script. Object Type: string @@ -1081,6 +1126,7 @@ def update_onguard_custom_script_by_onguard_custom_script_id( "output_details" : {}, #Output Details of Custom Script, applicable only for health collection scripts (e.g. {"ExitCode":"Integer", "OutVar1":"Boolean", "OutVar2":"String"}). Object Type: object "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Custom Script, applicable only for health collection scripts. Object Type: string "rules" : {}, #List of Rules for Custom Script, applicable only for health collection scripts (e.g. [{"match_type":"OR","health_status":"Healthy","condition":[{"type":"Script","name":"ExitCode","oper":"EQUALS","value":"0"}]}]). Object Type: object + } """ url_path = "/onguard-custom-script/{onguard_custom_script_id}" @@ -1102,6 +1148,7 @@ def replace_onguard_custom_script_by_onguard_custom_script_id( Required Body Parameters:['name', 'os_type', 'script_type', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Custom Script. Object Type: string "description" : "", #Description of Custom Script. Object Type: string @@ -1112,6 +1159,7 @@ def replace_onguard_custom_script_by_onguard_custom_script_id( "output_details" : {}, #Output Details of Custom Script, applicable only for health collection scripts (e.g. {"ExitCode":"Integer", "OutVar1":"Boolean", "OutVar2":"String"}). Object Type: object "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Custom Script, applicable only for health collection scripts. Object Type: string "rules" : {}, #List of Rules for Custom Script, applicable only for health collection scripts (e.g. [{"match_type":"OR","health_status":"Healthy","condition":[{"type":"Script","name":"ExitCode","oper":"EQUALS","value":"0"}]}]). Object Type: object + } """ url_path = "/onguard-custom-script/{onguard_custom_script_id}" @@ -1157,6 +1205,7 @@ def update_onguard_custom_script_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Custom Script. Object Type: string "description" : "", #Description of Custom Script. Object Type: string @@ -1165,6 +1214,7 @@ def update_onguard_custom_script_name_by_name(self, name="", body=({})): "output_details" : {}, #Output Details of Custom Script, applicable only for health collection scripts (e.g. {"ExitCode":"Integer", "OutVar1":"Boolean", "OutVar2":"String"}). Object Type: object "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Custom Script, applicable only for health collection scripts. Object Type: string "rules" : {}, #List of Rules for Custom Script, applicable only for health collection scripts (e.g. [{"match_type":"OR","health_status":"Healthy","condition":[{"type":"Script","name":"ExitCode","oper":"EQUALS","value":"0"}]}]). Object Type: object + } """ url_path = "/onguard-custom-script/name/{name}" @@ -1184,6 +1234,7 @@ def replace_onguard_custom_script_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'os_type', 'script_type', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of Custom Script. Object Type: string "description" : "", #Description of Custom Script. Object Type: string @@ -1194,6 +1245,7 @@ def replace_onguard_custom_script_name_by_name(self, name="", body=({})): "output_details" : {}, #Output Details of Custom Script, applicable only for health collection scripts (e.g. {"ExitCode":"Integer", "OutVar1":"Boolean", "OutVar2":"String"}). Object Type: object "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Custom Script, applicable only for health collection scripts. Object Type: string "rules" : {}, #List of Rules for Custom Script, applicable only for health collection scripts (e.g. [{"match_type":"OR","health_status":"Healthy","condition":[{"type":"Script","name":"ExitCode","oper":"EQUALS","value":"0"}]}]). Object Type: object + } """ url_path = "/onguard-custom-script/name/{name}" @@ -1233,6 +1285,7 @@ def new_onguard_global_settings(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "AllowRemoteDesktopSession" : False, #Enable access over Remote Desktop Session. Object Type: boolean "CacheCredentialsForDays" : 0, #Cache Credentials Interval(in days). Object Type: integer @@ -1253,6 +1306,7 @@ def new_onguard_global_settings(self, body=({})): "VPNDeviceNamesLinux" : "", #VPN Device Names (Linux). Object Type: string "WiredAllowedSubnets" : "", #[Deprecated] Allowed Subnets for Wired access. Object Type: string "WirelessAllowedSubnets" : "", #[Deprecated] Allowed Subnets for Wireless access. Object Type: string + } """ url_path = "/onguard/global-settings" @@ -1277,6 +1331,7 @@ def new_onguard_settings(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "mode" : "", #Mode of operation. Object Type: string "interfaces" : "", #[wired, wireless, vpn, other]: Network interfaces Agent should monitor. Object Type: string @@ -1296,6 +1351,7 @@ def new_onguard_settings(self, body=({})): "ip_version_onguard" : "", #IP Version for Server Communication (OnGuard). Object Type: string "ip_version_native" : "", #IP Version for Server Communication (Native). Object Type: string "custom_remediation" : {}, #Customize webpage details for Agent Remediation UI. Input should be in JSON format.. Object Type: object + } """ url_path = "/onguard/settings" @@ -1320,10 +1376,12 @@ def new_onguard_policy_manager_zones(self, body=({})): Required Body Parameters:['policy_manager_zone_name', 'client_subnets'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "policy_manager_zone_name" : "", #Name of the Policy Manager Zone. Object Type: string "client_subnets" : "", #client subnet addresses specific to the Policy Manager zone. Object Type: string "override_server_ips" : "", #IP addresses or FQDN to which OnGuard agent will send request. This will override the Default ClearPass Server IPs. Object Type: string + } """ url_path = "/onguard/policy-manager-zones" @@ -1356,9 +1414,11 @@ def update_onguard_policy_manager_zones_by_policy_manager_zones_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "client_subnets" : "", #client subnet addresses specific to the Policy Manager zone. Object Type: string "override_server_ips" : "", #IP addresses or FQDN to which OnGuard agent will send request. This will override the Default ClearPass Server IPs. Object Type: string + } """ url_path = "/onguard/policy-manager-zones/{policy_manager_zones_id}" @@ -1380,9 +1440,11 @@ def replace_onguard_policy_manager_zones_by_policy_manager_zones_id( Required Body Parameters:['client_subnets'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "client_subnets" : "", #client subnet addresses specific to the Policy Manager zone. Object Type: string "override_server_ips" : "", #IP addresses or FQDN to which OnGuard agent will send request. This will override the Default ClearPass Server IPs. Object Type: string + } """ url_path = "/onguard/policy-manager-zones/{policy_manager_zones_id}" @@ -1428,9 +1490,11 @@ def update_onguard_policy_manager_zones_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "client_subnets" : "", #client subnet addresses specific to the Policy Manager zone. Object Type: string "override_server_ips" : "", #IP addresses or FQDN to which OnGuard agent will send request. This will override the Default ClearPass Server IPs. Object Type: string + } """ url_path = "/onguard/policy-manager-zones/name/{name}" @@ -1450,9 +1514,11 @@ def replace_onguard_policy_manager_zones_name_by_name(self, name="", body=({})): Required Body Parameters:['client_subnets'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "client_subnets" : "", #client subnet addresses specific to the Policy Manager zone. Object Type: string "override_server_ips" : "", #IP addresses or FQDN to which OnGuard agent will send request. This will override the Default ClearPass Server IPs. Object Type: string + } """ url_path = "/onguard/policy-manager-zones/name/{name}" @@ -1492,10 +1558,12 @@ def new_profiler_subnet_mapping(self, body=({})): Required Body Parameters:['network', 'scan_type', 'ext_accounts'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "network" : "", #IP Subnets/IP Addresses in CSV format (e.g. "10.21.11.0/24,12.12.12.12"). Object Type: string "scan_type" : "", #Scan type of Profiler Subnet Mapping. Object Type: string "ext_accounts" : "", #List of external account names according to Scan Type (e.g. ["acc-wmi-1", "acc-wmi-2", "acc-wmi-3"] for Scan Type WMI). Object Type: array + } """ url_path = "/profiler-subnet-mapping" @@ -1533,10 +1601,12 @@ def update_profiler_subnet_mapping_by_scan_type_profiler_subnet_mapping_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "network" : "", #IP Subnets/IP Addresses in CSV format (e.g. "10.21.11.0/24,12.12.12.12"). Object Type: string "scan_type" : "", #Scan type of Profiler Subnet Mapping. Object Type: string "ext_accounts" : "", #List of external account names according to Scan Type (e.g. ["acc-wmi-1", "acc-wmi-2", "acc-wmi-3"] for Scan Type WMI). Object Type: array + } """ url_path = "/profiler-subnet-mapping/{scan_type}/{profiler_subnet_mapping_id}" @@ -1562,10 +1632,12 @@ def replace_profiler_subnet_mapping_by_scan_type_profiler_subnet_mapping_id( Required Body Parameters:['network', 'scan_type', 'ext_accounts'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "network" : "", #IP Subnets/IP Addresses in CSV format (e.g. "10.21.11.0/24,12.12.12.12"). Object Type: string "scan_type" : "", #Scan type of Profiler Subnet Mapping. Object Type: string "ext_accounts" : "", #List of external account names according to Scan Type (e.g. ["acc-wmi-1", "acc-wmi-2", "acc-wmi-3"] for Scan Type WMI). Object Type: array + } """ url_path = "/profiler-subnet-mapping/{scan_type}/{profiler_subnet_mapping_id}" @@ -1624,10 +1696,12 @@ def update_profiler_subnet_mapping_by_scan_type_network_network( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "network" : "", #IP Subnets/IP Addresses in CSV format (e.g. "10.21.11.0/24,12.12.12.12"). Object Type: string "scan_type" : "", #Scan type of Profiler Subnet Mapping. Object Type: string "ext_accounts" : "", #List of external account names according to Scan Type (e.g. ["acc-wmi-1", "acc-wmi-2", "acc-wmi-3"] for Scan Type WMI). Object Type: array + } """ url_path = "/profiler-subnet-mapping/{scan_type}/network/{network}" @@ -1650,10 +1724,12 @@ def replace_profiler_subnet_mapping_by_scan_type_network_network( Required Body Parameters:['network', 'scan_type', 'ext_accounts'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "network" : "", #IP Subnets/IP Addresses in CSV format (e.g. "10.21.11.0/24,12.12.12.12"). Object Type: string "scan_type" : "", #Scan type of Profiler Subnet Mapping. Object Type: string "ext_accounts" : "", #List of external account names according to Scan Type (e.g. ["acc-wmi-1", "acc-wmi-2", "acc-wmi-3"] for Scan Type WMI). Object Type: array + } """ url_path = "/profiler-subnet-mapping/{scan_type}/network/{network}" @@ -1711,6 +1787,7 @@ def new_windows_hotfix(self, body=({})): Required Body Parameters:['kbid', 'operating_system', 'title', 'severity_rating'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "kbid" : "", #KBID of the windows hotfix. Object Type: string "operating_system" : "", #OS of the windows hotfix. Object Type: string @@ -1722,6 +1799,7 @@ def new_windows_hotfix(self, body=({})): "release_date" : "", #Release Date of the windows hotfix. Object Type: string "url" : "", #URL of the windows hotfix. Object Type: string "description" : "", #Description of the windows hotfix. Object Type: string + } """ url_path = "/windows-hotfix" @@ -1752,6 +1830,7 @@ def update_windows_hotfix_by_windows_hotfix_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "kbid" : "", #KBID of the windows hotfix. Object Type: string "operating_system" : "", #OS of the windows hotfix. Object Type: string @@ -1763,6 +1842,7 @@ def update_windows_hotfix_by_windows_hotfix_id( "release_date" : "", #Release Date of the windows hotfix. Object Type: string "url" : "", #URL of the windows hotfix. Object Type: string "description" : "", #Description of the windows hotfix. Object Type: string + } """ url_path = "/windows-hotfix/{windows_hotfix_id}" @@ -1784,6 +1864,7 @@ def replace_windows_hotfix_by_windows_hotfix_id( Required Body Parameters:['kbid', 'operating_system', 'title', 'severity_rating'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "kbid" : "", #KBID of the windows hotfix. Object Type: string "operating_system" : "", #OS of the windows hotfix. Object Type: string @@ -1795,6 +1876,7 @@ def replace_windows_hotfix_by_windows_hotfix_id( "release_date" : "", #Release Date of the windows hotfix. Object Type: string "url" : "", #URL of the windows hotfix. Object Type: string "description" : "", #Description of the windows hotfix. Object Type: string + } """ url_path = "/windows-hotfix/{windows_hotfix_id}" @@ -1844,6 +1926,7 @@ def update_windows_hotfix_kbid_by_kbid_operating_system_operating_system( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "kbid" : "", #KBID of the windows hotfix. Object Type: string "operating_system" : "", #OS of the windows hotfix. Object Type: string @@ -1855,6 +1938,7 @@ def update_windows_hotfix_kbid_by_kbid_operating_system_operating_system( "release_date" : "", #Release Date of the windows hotfix. Object Type: string "url" : "", #URL of the windows hotfix. Object Type: string "description" : "", #Description of the windows hotfix. Object Type: string + } """ url_path = "/windows-hotfix/kbid/{kbid}/operating_system/{operating_system}" @@ -1877,6 +1961,7 @@ def replace_windows_hotfix_kbid_by_kbid_operating_system_operating_system( Required Body Parameters:['kbid', 'operating_system', 'title', 'severity_rating'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "kbid" : "", #KBID of the windows hotfix. Object Type: string "operating_system" : "", #OS of the windows hotfix. Object Type: string @@ -1888,6 +1973,7 @@ def replace_windows_hotfix_kbid_by_kbid_operating_system_operating_system( "release_date" : "", #Release Date of the windows hotfix. Object Type: string "url" : "", #URL of the windows hotfix. Object Type: string "description" : "", #Description of the windows hotfix. Object Type: string + } """ url_path = "/windows-hotfix/kbid/{kbid}/operating_system/{operating_system}" diff --git a/pyclearpass/api_enforcementprofile.py b/pyclearpass/api_enforcementprofile.py index 9012213..cdc4021 100644 --- a/pyclearpass/api_enforcementprofile.py +++ b/pyclearpass/api_enforcementprofile.py @@ -1,30 +1,32 @@ from pyclearpass.common import ( _generate_parameterised_url, _remove_empty_keys, - ClearPassAPILogin + ClearPassAPILogin, ) # API Category Name: EnforcementProfile # FileName: api_enforcementprofile.py -class ApiEnforcementProfile(ClearPassAPILogin): - # API Service: Manage Captive Portal Profile - def get_enforcement_profile_dur_captive_portal_profile_by_product_name(self,product_name=""): +class ApiEnforcementProfile(ClearPassAPILogin): + # API Service: Manage Captive Portal Profile + def get_enforcement_profile_dur_captive_portal_profile_by_product_name( + self, product_name="" + ): """ Operation: GET a list of Captive Portal Profiles HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/captive-portal-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_captive_portal_profile_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_captive_portal_profile_by_product_name( + self, product_name="", body=({}) + ): """ Operation: Add a Captive Portal Profile HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -32,38 +34,45 @@ def new_enforcement_profile_dur_captive_portal_profile_by_product_name(self,prod Required Body Parameters:['name', 'url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Captive Portal Profile. Object Type: string "url" : "", #URL for ArubaOS-Switch and AOS-CX Captive Portal Profile. Object Type: string "url_hashkey" : "", #URL HashKey for ArubaOS-Switch Captive Portal Profile. Object Type: string - "aos_attributes" : "" #variable unknown: , #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + "aos_attributes" : "", #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + } """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/captive-portal-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id(self,product_name="",captive_portal_profile_id=""): + def get_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id( + self, product_name="", captive_portal_profile_id="" + ): """ Operation: Get a Captive Portal Profile HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: captive_portal_profile_id, Description: Numeric ID of the Captive Portal Profile """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}' - dict_path={'product_name': product_name, 'captive_portal_profile_id': captive_portal_profile_id} + url_path = "/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}" + dict_path = { + "product_name": product_name, + "captive_portal_profile_id": captive_portal_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id(self,product_name="",captive_portal_profile_id="",body=({})): + def update_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id( + self, product_name="", captive_portal_profile_id="", body=({}) + ): """ Operation: Update some fields of a Captive Portal Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -72,23 +81,30 @@ def update_enforcement_profile_dur_captive_portal_profile_by_product_name_captiv Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Captive Portal Profile. Object Type: string "url" : "", #URL for ArubaOS-Switch and AOS-CX Captive Portal Profile. Object Type: string "url_hashkey" : "", #URL HashKey for ArubaOS-Switch Captive Portal Profile. Object Type: string - "aos_attributes" : "" #variable unknown: , #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + "aos_attributes" : "", #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + } """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}' - dict_path={'product_name': product_name, 'captive_portal_profile_id': captive_portal_profile_id} + url_path = "/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}" + dict_path = { + "product_name": product_name, + "captive_portal_profile_id": captive_portal_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id(self,product_name="",captive_portal_profile_id="",body=({})): + def replace_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id( + self, product_name="", captive_portal_profile_id="", body=({}) + ): """ Operation: Replace a Captive Portal Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -97,53 +113,65 @@ def replace_enforcement_profile_dur_captive_portal_profile_by_product_name_capti Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Captive Portal Profile. Object Type: string "url" : "", #URL for ArubaOS-Switch and AOS-CX Captive Portal Profile. Object Type: string "url_hashkey" : "", #URL HashKey for ArubaOS-Switch Captive Portal Profile. Object Type: string - "aos_attributes" : "" #variable unknown: , #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + "aos_attributes" : "", #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + } """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}' - dict_path={'product_name': product_name, 'captive_portal_profile_id': captive_portal_profile_id} + url_path = "/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}" + dict_path = { + "product_name": product_name, + "captive_portal_profile_id": captive_portal_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id(self,product_name="",captive_portal_profile_id=""): + def delete_enforcement_profile_dur_captive_portal_profile_by_product_name_captive_portal_profile_id( + self, product_name="", captive_portal_profile_id="" + ): """ Operation: Delete a Captive Portal Profile HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: captive_portal_profile_id, Description: Numeric ID of the Captive Portal Profile """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}' - dict_path={'product_name': product_name, 'captive_portal_profile_id': captive_portal_profile_id} + url_path = "/enforcement-profile-dur/captive-portal-profile/{product_name}/{captive_portal_profile_id}" + dict_path = { + "product_name": product_name, + "captive_portal_profile_id": captive_portal_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Captive Portal Profile by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Captive Portal Profile """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' + url_path = ( + "/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}" ) + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Update some fields of a Captive Portal Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -152,23 +180,29 @@ def update_enforcement_profile_dur_captive_portal_profile_by_product_name_name_n Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Captive Portal Profile. Object Type: string "url" : "", #URL for ArubaOS-Switch and AOS-CX Captive Portal Profile. Object Type: string "url_hashkey" : "", #URL HashKey for ArubaOS-Switch Captive Portal Profile. Object Type: string - "aos_attributes" : "" #variable unknown: , #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + "aos_attributes" : "", #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + } """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = ( + "/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}" + ) + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Replace a Captive Portal Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -177,523 +211,549 @@ def replace_enforcement_profile_dur_captive_portal_profile_by_product_name_name_ Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Captive Portal Profile. Object Type: string "url" : "", #URL for ArubaOS-Switch and AOS-CX Captive Portal Profile. Object Type: string "url_hashkey" : "", #URL HashKey for ArubaOS-Switch Captive Portal Profile. Object Type: string - "aos_attributes" : "" #variable unknown: , #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + "aos_attributes" : "", #Attributes for Mobility Access Switch and Mobility Controller Captive Portal Profile. Object Type: AosAttributes + } """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = ( + "/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}" + ) + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_captive_portal_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Captive Portal Profile by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Captive Portal Profile """ - url_path='/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' + url_path = ( + "/enforcement-profile-dur/captive-portal-profile/{product_name}/name/{name}" ) + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage DUR Class - def get_enforcement_profile_dur_dur_class_by_product_name(self,product_name=""): + def get_enforcement_profile_dur_dur_class_by_product_name(self, product_name=""): """ Operation: GET a list of Policies HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/dur-class/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def new_enforcement_profile_dur_dur_class_by_product_name(self,product_name="",body=({})): - """ - Operation: Add a DUR Class - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name', 'hpe_rules', 'aos_cx_rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the DUR Class. Object Type: string - "traffic" : "", #Traffic of the DUR Class. Object Type: string - "hpe_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "traffic_match_type":"", #Traffic Match Type. Object Type: string - "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string - "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string - "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string - "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string - "source":"", #Source for protocol traffic_match_type. Object Type: string - "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string - "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string - "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer - "destination":"", #Destnation for protocol traffic_match_type. Object Type: string - "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string - "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string - "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string - "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer - "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer - "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string - "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string - "established":false, #Established for tcp protocol. Object Type: boolean - "fin":false, #Fin for tcp protocol. Object Type: boolean - "rst":false, #Rst for tcp protocol. Object Type: boolean - "syn":false, #Syn for tcp protocol. Object Type: boolean -}], #Rules for ArubaOS-Switch DUR Class. Object Type: array - "aos_cx_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "protocol":"", #Protocol. Object Type: string - "protocol_number":0, #Protocol Number for number protocol. Object Type: integer - "source":"", #Source. Object Type: string - "source_ip_address":"", #Source IP Address for ip source. Object Type: string - "source_port":"", #Source Port. Object Type: string - "source_port_value":"", #Source Port Value. Object Type: string - "destination":"", #Destination. Object Type: string - "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string - "destination_port":"", #Destination Port. Object Type: string - "destination_port_value":"", #Destination Port Value. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "vlan_id":0, #VLAN ID (1-4094). Object Type: integer - "ecn":0, #ECN (0-3). Object Type: integer - "ip_precedence":"", #IP Precedence. Object Type: string - "service_type":0, #Type of Service (0-31). Object Type: integer - "ttl":0, #Time to Live (0-255). Object Type: integer - "fragment":false, #Fragment. Object Type: boolean - "count_packet":false, #Count Packet. Object Type: boolean - "cwr":false, #cwr for tcp protocol. Object Type: boolean - "ece":false, #ece for tcp protocol. Object Type: boolean - "urg":false, #urg for tcp protocol. Object Type: boolean - "ack":false, #ack for tcp protocol. Object Type: boolean - "psh":false, #psh for tcp protocol. Object Type: boolean - "rst":false, #rst for tcp protocol. Object Type: boolean - "syn":false, #syn for tcp protocol. Object Type: boolean - "fin":false, #fin for tcp protocol. Object Type: boolean - "established":false, #established for tcp protocol. Object Type: boolean - "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string - "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer - "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer -}], #Rules for AOS-CX DUR Class. Object Type: array - } - """ - url_path='/enforcement-profile-dur/dur-class/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/dur-class/{product_name}" + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def new_enforcement_profile_dur_dur_class_by_product_name( + self, product_name="", body=({}) + ): + """ + Operation: Add a DUR Class + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name', 'hpe_rules', 'aos_cx_rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the DUR Class. Object Type: string + "traffic" : "", #Traffic of the DUR Class. Object Type: string + "hpe_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "traffic_match_type":"", #Traffic Match Type. Object Type: string + "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string + "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string + "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string + "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string + "source":"", #Source for protocol traffic_match_type. Object Type: string + "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string + "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string + "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer + "destination":"", #Destnation for protocol traffic_match_type. Object Type: string + "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string + "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string + "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string + "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer + "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer + "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string + "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string + "established":false, #Established for tcp protocol. Object Type: boolean + "fin":false, #Fin for tcp protocol. Object Type: boolean + "rst":false, #Rst for tcp protocol. Object Type: boolean + "syn":false, #Syn for tcp protocol. Object Type: boolean + }], #Rules for ArubaOS-Switch DUR Class. Object Type: array + "aos_cx_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "protocol":"", #Protocol. Object Type: string + "protocol_number":0, #Protocol Number for number protocol. Object Type: integer + "source":"", #Source. Object Type: string + "source_ip_address":"", #Source IP Address for ip source. Object Type: string + "source_port":"", #Source Port. Object Type: string + "source_port_value":"", #Source Port Value. Object Type: string + "destination":"", #Destination. Object Type: string + "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string + "destination_port":"", #Destination Port. Object Type: string + "destination_port_value":"", #Destination Port Value. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "vlan_id":0, #VLAN ID (1-4094). Object Type: integer + "ecn":0, #ECN (0-3). Object Type: integer + "ip_precedence":"", #IP Precedence. Object Type: string + "service_type":0, #Type of Service (0-31). Object Type: integer + "ttl":0, #Time to Live (0-255). Object Type: integer + "fragment":false, #Fragment. Object Type: boolean + "count_packet":false, #Count Packet. Object Type: boolean + "cwr":false, #cwr for tcp protocol. Object Type: boolean + "ece":false, #ece for tcp protocol. Object Type: boolean + "urg":false, #urg for tcp protocol. Object Type: boolean + "ack":false, #ack for tcp protocol. Object Type: boolean + "psh":false, #psh for tcp protocol. Object Type: boolean + "rst":false, #rst for tcp protocol. Object Type: boolean + "syn":false, #syn for tcp protocol. Object Type: boolean + "fin":false, #fin for tcp protocol. Object Type: boolean + "established":false, #established for tcp protocol. Object Type: boolean + "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string + "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer + "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer + }], #Rules for AOS-CX DUR Class. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/dur-class/{product_name}" + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_dur_class_by_product_name_dur_class_id(self,product_name="",dur_class_id=""): + def get_enforcement_profile_dur_dur_class_by_product_name_dur_class_id( + self, product_name="", dur_class_id="" + ): """ Operation: Get a DUR Class HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: dur_class_id, Description: Numeric ID of the DURClass """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}' - dict_path={'product_name': product_name, 'dur_class_id': dur_class_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_dur_class_by_product_name_dur_class_id(self,product_name="",dur_class_id="",body=({})): - """ - Operation: Update a DUR Class - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: dur_class_id, Description: Numeric ID of the DURClass - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the DUR Class. Object Type: string - "traffic" : "", #Traffic of the DUR Class. Object Type: string - "hpe_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "traffic_match_type":"", #Traffic Match Type. Object Type: string - "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string - "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string - "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string - "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string - "source":"", #Source for protocol traffic_match_type. Object Type: string - "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string - "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string - "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer - "destination":"", #Destnation for protocol traffic_match_type. Object Type: string - "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string - "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string - "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string - "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer - "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer - "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string - "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string - "established":false, #Established for tcp protocol. Object Type: boolean - "fin":false, #Fin for tcp protocol. Object Type: boolean - "rst":false, #Rst for tcp protocol. Object Type: boolean - "syn":false, #Syn for tcp protocol. Object Type: boolean -}], #Rules for ArubaOS-Switch DUR Class. Object Type: array - "aos_cx_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "protocol":"", #Protocol. Object Type: string - "protocol_number":0, #Protocol Number for number protocol. Object Type: integer - "source":"", #Source. Object Type: string - "source_ip_address":"", #Source IP Address for ip source. Object Type: string - "source_port":"", #Source Port. Object Type: string - "source_port_value":"", #Source Port Value. Object Type: string - "destination":"", #Destination. Object Type: string - "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string - "destination_port":"", #Destination Port. Object Type: string - "destination_port_value":"", #Destination Port Value. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "vlan_id":0, #VLAN ID (1-4094). Object Type: integer - "ecn":0, #ECN (0-3). Object Type: integer - "ip_precedence":"", #IP Precedence. Object Type: string - "service_type":0, #Type of Service (0-31). Object Type: integer - "ttl":0, #Time to Live (0-255). Object Type: integer - "fragment":false, #Fragment. Object Type: boolean - "count_packet":false, #Count Packet. Object Type: boolean - "cwr":false, #cwr for tcp protocol. Object Type: boolean - "ece":false, #ece for tcp protocol. Object Type: boolean - "urg":false, #urg for tcp protocol. Object Type: boolean - "ack":false, #ack for tcp protocol. Object Type: boolean - "psh":false, #psh for tcp protocol. Object Type: boolean - "rst":false, #rst for tcp protocol. Object Type: boolean - "syn":false, #syn for tcp protocol. Object Type: boolean - "fin":false, #fin for tcp protocol. Object Type: boolean - "established":false, #established for tcp protocol. Object Type: boolean - "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string - "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer - "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer -}], #Rules for AOS-CX DUR Class. Object Type: array - } - """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}' - dict_path={'product_name': product_name, 'dur_class_id': dur_class_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}" + dict_path = {"product_name": product_name, "dur_class_id": dur_class_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_dur_class_by_product_name_dur_class_id( + self, product_name="", dur_class_id="", body=({}) + ): + """ + Operation: Update a DUR Class + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: dur_class_id, Description: Numeric ID of the DURClass + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the DUR Class. Object Type: string + "traffic" : "", #Traffic of the DUR Class. Object Type: string + "hpe_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "traffic_match_type":"", #Traffic Match Type. Object Type: string + "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string + "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string + "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string + "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string + "source":"", #Source for protocol traffic_match_type. Object Type: string + "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string + "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string + "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer + "destination":"", #Destnation for protocol traffic_match_type. Object Type: string + "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string + "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string + "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string + "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer + "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer + "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string + "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string + "established":false, #Established for tcp protocol. Object Type: boolean + "fin":false, #Fin for tcp protocol. Object Type: boolean + "rst":false, #Rst for tcp protocol. Object Type: boolean + "syn":false, #Syn for tcp protocol. Object Type: boolean + }], #Rules for ArubaOS-Switch DUR Class. Object Type: array + "aos_cx_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "protocol":"", #Protocol. Object Type: string + "protocol_number":0, #Protocol Number for number protocol. Object Type: integer + "source":"", #Source. Object Type: string + "source_ip_address":"", #Source IP Address for ip source. Object Type: string + "source_port":"", #Source Port. Object Type: string + "source_port_value":"", #Source Port Value. Object Type: string + "destination":"", #Destination. Object Type: string + "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string + "destination_port":"", #Destination Port. Object Type: string + "destination_port_value":"", #Destination Port Value. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "vlan_id":0, #VLAN ID (1-4094). Object Type: integer + "ecn":0, #ECN (0-3). Object Type: integer + "ip_precedence":"", #IP Precedence. Object Type: string + "service_type":0, #Type of Service (0-31). Object Type: integer + "ttl":0, #Time to Live (0-255). Object Type: integer + "fragment":false, #Fragment. Object Type: boolean + "count_packet":false, #Count Packet. Object Type: boolean + "cwr":false, #cwr for tcp protocol. Object Type: boolean + "ece":false, #ece for tcp protocol. Object Type: boolean + "urg":false, #urg for tcp protocol. Object Type: boolean + "ack":false, #ack for tcp protocol. Object Type: boolean + "psh":false, #psh for tcp protocol. Object Type: boolean + "rst":false, #rst for tcp protocol. Object Type: boolean + "syn":false, #syn for tcp protocol. Object Type: boolean + "fin":false, #fin for tcp protocol. Object Type: boolean + "established":false, #established for tcp protocol. Object Type: boolean + "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string + "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer + "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer + }], #Rules for AOS-CX DUR Class. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}" + dict_path = {"product_name": product_name, "dur_class_id": dur_class_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_dur_class_by_product_name_dur_class_id(self,product_name="",dur_class_id="",body=({})): - """ - Operation: Replace a DUR Class - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: dur_class_id, Description: Numeric ID of the DURClass - Required Body Parameters:['name', 'hpe_rules', 'aos_cx_rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the DUR Class. Object Type: string - "traffic" : "", #Traffic of the DUR Class. Object Type: string - "hpe_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "traffic_match_type":"", #Traffic Match Type. Object Type: string - "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string - "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string - "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string - "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string - "source":"", #Source for protocol traffic_match_type. Object Type: string - "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string - "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string - "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer - "destination":"", #Destnation for protocol traffic_match_type. Object Type: string - "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string - "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string - "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string - "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer - "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer - "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string - "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string - "established":false, #Established for tcp protocol. Object Type: boolean - "fin":false, #Fin for tcp protocol. Object Type: boolean - "rst":false, #Rst for tcp protocol. Object Type: boolean - "syn":false, #Syn for tcp protocol. Object Type: boolean -}], #Rules for ArubaOS-Switch DUR Class. Object Type: array - "aos_cx_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "protocol":"", #Protocol. Object Type: string - "protocol_number":0, #Protocol Number for number protocol. Object Type: integer - "source":"", #Source. Object Type: string - "source_ip_address":"", #Source IP Address for ip source. Object Type: string - "source_port":"", #Source Port. Object Type: string - "source_port_value":"", #Source Port Value. Object Type: string - "destination":"", #Destination. Object Type: string - "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string - "destination_port":"", #Destination Port. Object Type: string - "destination_port_value":"", #Destination Port Value. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "vlan_id":0, #VLAN ID (1-4094). Object Type: integer - "ecn":0, #ECN (0-3). Object Type: integer - "ip_precedence":"", #IP Precedence. Object Type: string - "service_type":0, #Type of Service (0-31). Object Type: integer - "ttl":0, #Time to Live (0-255). Object Type: integer - "fragment":false, #Fragment. Object Type: boolean - "count_packet":false, #Count Packet. Object Type: boolean - "cwr":false, #cwr for tcp protocol. Object Type: boolean - "ece":false, #ece for tcp protocol. Object Type: boolean - "urg":false, #urg for tcp protocol. Object Type: boolean - "ack":false, #ack for tcp protocol. Object Type: boolean - "psh":false, #psh for tcp protocol. Object Type: boolean - "rst":false, #rst for tcp protocol. Object Type: boolean - "syn":false, #syn for tcp protocol. Object Type: boolean - "fin":false, #fin for tcp protocol. Object Type: boolean - "established":false, #established for tcp protocol. Object Type: boolean - "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string - "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer - "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer -}], #Rules for AOS-CX DUR Class. Object Type: array - } - """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}' - dict_path={'product_name': product_name, 'dur_class_id': dur_class_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_dur_class_by_product_name_dur_class_id( + self, product_name="", dur_class_id="", body=({}) + ): + """ + Operation: Replace a DUR Class + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: dur_class_id, Description: Numeric ID of the DURClass + Required Body Parameters:['name', 'hpe_rules', 'aos_cx_rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the DUR Class. Object Type: string + "traffic" : "", #Traffic of the DUR Class. Object Type: string + "hpe_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "traffic_match_type":"", #Traffic Match Type. Object Type: string + "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string + "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string + "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string + "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string + "source":"", #Source for protocol traffic_match_type. Object Type: string + "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string + "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string + "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer + "destination":"", #Destnation for protocol traffic_match_type. Object Type: string + "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string + "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string + "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string + "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer + "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer + "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string + "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string + "established":false, #Established for tcp protocol. Object Type: boolean + "fin":false, #Fin for tcp protocol. Object Type: boolean + "rst":false, #Rst for tcp protocol. Object Type: boolean + "syn":false, #Syn for tcp protocol. Object Type: boolean + }], #Rules for ArubaOS-Switch DUR Class. Object Type: array + "aos_cx_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "protocol":"", #Protocol. Object Type: string + "protocol_number":0, #Protocol Number for number protocol. Object Type: integer + "source":"", #Source. Object Type: string + "source_ip_address":"", #Source IP Address for ip source. Object Type: string + "source_port":"", #Source Port. Object Type: string + "source_port_value":"", #Source Port Value. Object Type: string + "destination":"", #Destination. Object Type: string + "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string + "destination_port":"", #Destination Port. Object Type: string + "destination_port_value":"", #Destination Port Value. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "vlan_id":0, #VLAN ID (1-4094). Object Type: integer + "ecn":0, #ECN (0-3). Object Type: integer + "ip_precedence":"", #IP Precedence. Object Type: string + "service_type":0, #Type of Service (0-31). Object Type: integer + "ttl":0, #Time to Live (0-255). Object Type: integer + "fragment":false, #Fragment. Object Type: boolean + "count_packet":false, #Count Packet. Object Type: boolean + "cwr":false, #cwr for tcp protocol. Object Type: boolean + "ece":false, #ece for tcp protocol. Object Type: boolean + "urg":false, #urg for tcp protocol. Object Type: boolean + "ack":false, #ack for tcp protocol. Object Type: boolean + "psh":false, #psh for tcp protocol. Object Type: boolean + "rst":false, #rst for tcp protocol. Object Type: boolean + "syn":false, #syn for tcp protocol. Object Type: boolean + "fin":false, #fin for tcp protocol. Object Type: boolean + "established":false, #established for tcp protocol. Object Type: boolean + "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string + "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer + "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer + }], #Rules for AOS-CX DUR Class. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}" + dict_path = {"product_name": product_name, "dur_class_id": dur_class_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_dur_class_by_product_name_dur_class_id(self,product_name="",dur_class_id=""): + def delete_enforcement_profile_dur_dur_class_by_product_name_dur_class_id( + self, product_name="", dur_class_id="" + ): """ Operation: Delete a DUR Class HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: dur_class_id, Description: Numeric ID of the DURClass """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}' - dict_path={'product_name': product_name, 'dur_class_id': dur_class_id} + url_path = "/enforcement-profile-dur/dur-class/{product_name}/{dur_class_id}" + dict_path = {"product_name": product_name, "dur_class_id": dur_class_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_dur_class_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_dur_class_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a DUR Class by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the DURClass """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_dur_class_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Update a DUR Class by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the DURClass - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the DUR Class. Object Type: string - "traffic" : "", #Traffic of the DUR Class. Object Type: string - "hpe_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "traffic_match_type":"", #Traffic Match Type. Object Type: string - "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string - "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string - "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string - "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string - "source":"", #Source for protocol traffic_match_type. Object Type: string - "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string - "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string - "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer - "destination":"", #Destnation for protocol traffic_match_type. Object Type: string - "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string - "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string - "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string - "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer - "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer - "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string - "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string - "established":false, #Established for tcp protocol. Object Type: boolean - "fin":false, #Fin for tcp protocol. Object Type: boolean - "rst":false, #Rst for tcp protocol. Object Type: boolean - "syn":false, #Syn for tcp protocol. Object Type: boolean -}], #Rules for ArubaOS-Switch DUR Class. Object Type: array - "aos_cx_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "protocol":"", #Protocol. Object Type: string - "protocol_number":0, #Protocol Number for number protocol. Object Type: integer - "source":"", #Source. Object Type: string - "source_ip_address":"", #Source IP Address for ip source. Object Type: string - "source_port":"", #Source Port. Object Type: string - "source_port_value":"", #Source Port Value. Object Type: string - "destination":"", #Destination. Object Type: string - "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string - "destination_port":"", #Destination Port. Object Type: string - "destination_port_value":"", #Destination Port Value. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "vlan_id":0, #VLAN ID (1-4094). Object Type: integer - "ecn":0, #ECN (0-3). Object Type: integer - "ip_precedence":"", #IP Precedence. Object Type: string - "service_type":0, #Type of Service (0-31). Object Type: integer - "ttl":0, #Time to Live (0-255). Object Type: integer - "fragment":false, #Fragment. Object Type: boolean - "count_packet":false, #Count Packet. Object Type: boolean - "cwr":false, #cwr for tcp protocol. Object Type: boolean - "ece":false, #ece for tcp protocol. Object Type: boolean - "urg":false, #urg for tcp protocol. Object Type: boolean - "ack":false, #ack for tcp protocol. Object Type: boolean - "psh":false, #psh for tcp protocol. Object Type: boolean - "rst":false, #rst for tcp protocol. Object Type: boolean - "syn":false, #syn for tcp protocol. Object Type: boolean - "fin":false, #fin for tcp protocol. Object Type: boolean - "established":false, #established for tcp protocol. Object Type: boolean - "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string - "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer - "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer -}], #Rules for AOS-CX DUR Class. Object Type: array - } - """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/dur-class/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_dur_class_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Update a DUR Class by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the DURClass + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the DUR Class. Object Type: string + "traffic" : "", #Traffic of the DUR Class. Object Type: string + "hpe_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "traffic_match_type":"", #Traffic Match Type. Object Type: string + "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string + "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string + "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string + "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string + "source":"", #Source for protocol traffic_match_type. Object Type: string + "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string + "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string + "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer + "destination":"", #Destnation for protocol traffic_match_type. Object Type: string + "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string + "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string + "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string + "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer + "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer + "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string + "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string + "established":false, #Established for tcp protocol. Object Type: boolean + "fin":false, #Fin for tcp protocol. Object Type: boolean + "rst":false, #Rst for tcp protocol. Object Type: boolean + "syn":false, #Syn for tcp protocol. Object Type: boolean + }], #Rules for ArubaOS-Switch DUR Class. Object Type: array + "aos_cx_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "protocol":"", #Protocol. Object Type: string + "protocol_number":0, #Protocol Number for number protocol. Object Type: integer + "source":"", #Source. Object Type: string + "source_ip_address":"", #Source IP Address for ip source. Object Type: string + "source_port":"", #Source Port. Object Type: string + "source_port_value":"", #Source Port Value. Object Type: string + "destination":"", #Destination. Object Type: string + "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string + "destination_port":"", #Destination Port. Object Type: string + "destination_port_value":"", #Destination Port Value. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "vlan_id":0, #VLAN ID (1-4094). Object Type: integer + "ecn":0, #ECN (0-3). Object Type: integer + "ip_precedence":"", #IP Precedence. Object Type: string + "service_type":0, #Type of Service (0-31). Object Type: integer + "ttl":0, #Time to Live (0-255). Object Type: integer + "fragment":false, #Fragment. Object Type: boolean + "count_packet":false, #Count Packet. Object Type: boolean + "cwr":false, #cwr for tcp protocol. Object Type: boolean + "ece":false, #ece for tcp protocol. Object Type: boolean + "urg":false, #urg for tcp protocol. Object Type: boolean + "ack":false, #ack for tcp protocol. Object Type: boolean + "psh":false, #psh for tcp protocol. Object Type: boolean + "rst":false, #rst for tcp protocol. Object Type: boolean + "syn":false, #syn for tcp protocol. Object Type: boolean + "fin":false, #fin for tcp protocol. Object Type: boolean + "established":false, #established for tcp protocol. Object Type: boolean + "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string + "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer + "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer + }], #Rules for AOS-CX DUR Class. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/dur-class/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_dur_class_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Replace a DUR Class by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the DURClass - Required Body Parameters:['name', 'hpe_rules', 'aos_cx_rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the DUR Class. Object Type: string - "traffic" : "", #Traffic of the DUR Class. Object Type: string - "hpe_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "traffic_match_type":"", #Traffic Match Type. Object Type: string - "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string - "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string - "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string - "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string - "source":"", #Source for protocol traffic_match_type. Object Type: string - "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string - "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string - "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer - "destination":"", #Destnation for protocol traffic_match_type. Object Type: string - "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string - "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string - "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string - "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer - "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer - "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string - "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string - "established":false, #Established for tcp protocol. Object Type: boolean - "fin":false, #Fin for tcp protocol. Object Type: boolean - "rst":false, #Rst for tcp protocol. Object Type: boolean - "syn":false, #Syn for tcp protocol. Object Type: boolean -}], #Rules for ArubaOS-Switch DUR Class. Object Type: array - "aos_cx_rules" : [{ - "number":0, #Number (1-2147483647). Object Type: integer - "packet_match":"", #Packet Match. Object Type: string - "protocol":"", #Protocol. Object Type: string - "protocol_number":0, #Protocol Number for number protocol. Object Type: integer - "source":"", #Source. Object Type: string - "source_ip_address":"", #Source IP Address for ip source. Object Type: string - "source_port":"", #Source Port. Object Type: string - "source_port_value":"", #Source Port Value. Object Type: string - "destination":"", #Destination. Object Type: string - "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string - "destination_port":"", #Destination Port. Object Type: string - "destination_port_value":"", #Destination Port Value. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "vlan_id":0, #VLAN ID (1-4094). Object Type: integer - "ecn":0, #ECN (0-3). Object Type: integer - "ip_precedence":"", #IP Precedence. Object Type: string - "service_type":0, #Type of Service (0-31). Object Type: integer - "ttl":0, #Time to Live (0-255). Object Type: integer - "fragment":false, #Fragment. Object Type: boolean - "count_packet":false, #Count Packet. Object Type: boolean - "cwr":false, #cwr for tcp protocol. Object Type: boolean - "ece":false, #ece for tcp protocol. Object Type: boolean - "urg":false, #urg for tcp protocol. Object Type: boolean - "ack":false, #ack for tcp protocol. Object Type: boolean - "psh":false, #psh for tcp protocol. Object Type: boolean - "rst":false, #rst for tcp protocol. Object Type: boolean - "syn":false, #syn for tcp protocol. Object Type: boolean - "fin":false, #fin for tcp protocol. Object Type: boolean - "established":false, #established for tcp protocol. Object Type: boolean - "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string - "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer - "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer -}], #Rules for AOS-CX DUR Class. Object Type: array - } - """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_dur_class_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Replace a DUR Class by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the DURClass + Required Body Parameters:['name', 'hpe_rules', 'aos_cx_rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the DUR Class. Object Type: string + "traffic" : "", #Traffic of the DUR Class. Object Type: string + "hpe_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "traffic_match_type":"", #Traffic Match Type. Object Type: string + "net_source":"", #Net Source for netsource traffic_match_type. Object Type: string + "net_destination":"", #Net Destination for netsource traffic_match_type. Object Type: string + "net_service":"", #Net Service for netsource traffic_match_type. Object Type: string + "protocol":"", #Protocol for protocol traffic_match_type. Object Type: string + "source":"", #Source for protocol traffic_match_type. Object Type: string + "source_port":"", #Source Port for protocol traffic_match_type. Object Type: string + "source_port_value":"", #Source Port Value for protocol traffic_match_type. Object Type: string + "protocol_number":0, #Protocol Number (0-255) for 255 protocol. Object Type: integer + "destination":"", #Destnation for protocol traffic_match_type. Object Type: string + "destination_value":"", #Destination Value for protocol traffic_match_type. Object Type: string + "destination_port":"", #Destination Port for protocol traffic_match_type. Object Type: string + "destination_port_value":"", #Destination Port Value for protocol traffic_match_type. Object Type: string + "ip_dscp":0, #IP DSCP (0-63) for protocol traffic_match_type. Object Type: integer + "vlan_id":0, #VLAN ID (1-4094) for protocol traffic_match_type. Object Type: integer + "ip_precedence":"", #IP Precedence for protocol traffic_match_type. Object Type: string + "ip_service_type":"", #IP Type of Service for protocol traffic_match_type. Object Type: string + "established":false, #Established for tcp protocol. Object Type: boolean + "fin":false, #Fin for tcp protocol. Object Type: boolean + "rst":false, #Rst for tcp protocol. Object Type: boolean + "syn":false, #Syn for tcp protocol. Object Type: boolean + }], #Rules for ArubaOS-Switch DUR Class. Object Type: array + "aos_cx_rules" : [{ + "number":0, #Number (1-2147483647). Object Type: integer + "packet_match":"", #Packet Match. Object Type: string + "protocol":"", #Protocol. Object Type: string + "protocol_number":0, #Protocol Number for number protocol. Object Type: integer + "source":"", #Source. Object Type: string + "source_ip_address":"", #Source IP Address for ip source. Object Type: string + "source_port":"", #Source Port. Object Type: string + "source_port_value":"", #Source Port Value. Object Type: string + "destination":"", #Destination. Object Type: string + "destination_ip_address":"", #Destination IP Address for ip destination. Object Type: string + "destination_port":"", #Destination Port. Object Type: string + "destination_port_value":"", #Destination Port Value. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "vlan_id":0, #VLAN ID (1-4094). Object Type: integer + "ecn":0, #ECN (0-3). Object Type: integer + "ip_precedence":"", #IP Precedence. Object Type: string + "service_type":0, #Type of Service (0-31). Object Type: integer + "ttl":0, #Time to Live (0-255). Object Type: integer + "fragment":false, #Fragment. Object Type: boolean + "count_packet":false, #Count Packet. Object Type: boolean + "cwr":false, #cwr for tcp protocol. Object Type: boolean + "ece":false, #ece for tcp protocol. Object Type: boolean + "urg":false, #urg for tcp protocol. Object Type: boolean + "ack":false, #ack for tcp protocol. Object Type: boolean + "psh":false, #psh for tcp protocol. Object Type: boolean + "rst":false, #rst for tcp protocol. Object Type: boolean + "syn":false, #syn for tcp protocol. Object Type: boolean + "fin":false, #fin for tcp protocol. Object Type: boolean + "established":false, #established for tcp protocol. Object Type: boolean + "icmp_type":"", #ICMP Type for icmp protocol. Object Type: string + "icmp_type_value":0, #ICMP Type Value (0-255) for number icmp_type. Object Type: integer + "icmp_code":0, #ICMP Code (0-255) for icmp protocol. Object Type: integer + }], #Rules for AOS-CX DUR Class. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/dur-class/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_dur_class_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_dur_class_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a DUR Class by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the DURClass """ - url_path='/enforcement-profile-dur/dur-class/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/dur-class/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage Enforcement Profiles - def get_enforcement_profile(self,filter="",sort="",offset="",limit="",calculate_count=""): + def get_enforcement_profile( + self, filter="", sort="", offset="", limit="", calculate_count="" + ): """ Operation: Get a list of Enforcement Profiles HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -703,684 +763,806 @@ def get_enforcement_profile(self,filter="",sort="",offset="",limit="",calculate_ Parameter Type (Optional): query, Name: limit, Description: Maximum number of items to return (1 – 1000) Parameter Type (Optional): query, Name: calculate_count, Description: Whether to calculate the total item count """ - url_path='/enforcement-profile' - dict_query={'filter': filter, 'sort': sort, 'offset': offset, 'limit': limit, 'calculate_count': calculate_count} - url_path = _generate_parameterised_url(parameters = dict_query,url = url_path) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def new_enforcement_profile(self,body=({})): - """ - Operation: Create a new Enforcement Profile - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Required Body Parameters:['name', 'type'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Enforcement Profile. Object Type: string - "description" : "", #Description of the Enforcement Profile. Object Type: string - "type" : "", #Enforcement Profile Type. Object Type: string - "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string - "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "action" : "", #Enforcement Profile Action. Object Type: string - "device_group_list" : "", #Device Group List. Object Type: array - "attributes" : [{ - "type":"", #Type of the Attribute. Object Type: string - "name":"", #Name of the Attribute. Object Type: string - "value":"", #Value of the Attribute. Object Type: string -}], #Attributes. Object Type: array - "tacacs_service_params" : "" #variable unknown: , #Tacacs+ Service Params. Object Type: TacacsServiceParam - "dur_config" : "" #variable unknown: , #Downloadable User Role Configuration. Object Type: DURConfig + url_path = "/enforcement-profile" + dict_query = { + "filter": filter, + "sort": sort, + "offset": offset, + "limit": limit, + "calculate_count": calculate_count, } - """ - url_path='/enforcement-profile' + url_path = _generate_parameterised_url(parameters=dict_query, url=url_path) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def new_enforcement_profile(self, body=({})): + """ + Operation: Create a new Enforcement Profile + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Required Body Parameters:['name', 'type'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Enforcement Profile. Object Type: string + "description" : "", #Description of the Enforcement Profile. Object Type: string + "type" : "", #Enforcement Profile Type. Object Type: string + "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string + "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "action" : "", #Enforcement Profile Action. Object Type: string + "device_group_list" : "", #Device Group List. Object Type: array + "attributes" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Attributes. Object Type: array + "tacacs_service_params" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Tacacs+ Service Params. Object Type: TacacsServiceParam + "dur_config" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Downloadable User Role Configuration. Object Type: DURConfig + + } + """ + url_path = "/enforcement-profile" body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_by_enforcement_profile_id(self,enforcement_profile_id=""): + def get_enforcement_profile_by_enforcement_profile_id( + self, enforcement_profile_id="" + ): """ Operation: Get an Enforcement Profile HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: enforcement_profile_id, Description: Numeric ID of the Enforcement Profile """ - url_path='/enforcement-profile/{enforcement_profile_id}' - dict_path={'enforcement_profile_id': enforcement_profile_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_by_enforcement_profile_id(self,enforcement_profile_id="",body=({})): - """ - Operation: Update an Enforcement Profile - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: enforcement_profile_id, Description: Numeric ID of the Enforcement Profile - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Enforcement Profile. Object Type: string - "description" : "", #Description of the Enforcement Profile. Object Type: string - "type" : "", #Enforcement Profile Type. Object Type: string - "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string - "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "action" : "", #Enforcement Profile Action. Object Type: string - "device_group_list" : "", #Device Group List. Object Type: array - "attributes" : [{ - "type":"", #Type of the Attribute. Object Type: string - "name":"", #Name of the Attribute. Object Type: string - "value":"", #Value of the Attribute. Object Type: string -}], #Attributes. Object Type: array - "tacacs_service_params" : "" #variable unknown: , #Tacacs+ Service Params. Object Type: TacacsServiceParam - "dur_config" : "" #variable unknown: , #Downloadable User Role Configuration. Object Type: DURConfig - } - """ - url_path='/enforcement-profile/{enforcement_profile_id}' - dict_path={'enforcement_profile_id': enforcement_profile_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile/{enforcement_profile_id}" + dict_path = {"enforcement_profile_id": enforcement_profile_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_by_enforcement_profile_id( + self, enforcement_profile_id="", body=({}) + ): + """ + Operation: Update an Enforcement Profile + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: enforcement_profile_id, Description: Numeric ID of the Enforcement Profile + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Enforcement Profile. Object Type: string + "description" : "", #Description of the Enforcement Profile. Object Type: string + "type" : "", #Enforcement Profile Type. Object Type: string + "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string + "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "action" : "", #Enforcement Profile Action. Object Type: string + "device_group_list" : "", #Device Group List. Object Type: array + "attributes" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Attributes. Object Type: array + "tacacs_service_params" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Tacacs+ Service Params. Object Type: TacacsServiceParam + "dur_config" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Downloadable User Role Configuration. Object Type: DURConfig + + } + """ + url_path = "/enforcement-profile/{enforcement_profile_id}" + dict_path = {"enforcement_profile_id": enforcement_profile_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_by_enforcement_profile_id(self,enforcement_profile_id="",body=({})): - """ - Operation: Replace an Enforcement Profile - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: enforcement_profile_id, Description: Numeric ID of the Enforcement Profile - Required Body Parameters:['name', 'type'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Enforcement Profile. Object Type: string - "description" : "", #Description of the Enforcement Profile. Object Type: string - "type" : "", #Enforcement Profile Type. Object Type: string - "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string - "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "action" : "", #Enforcement Profile Action. Object Type: string - "device_group_list" : "", #Device Group List. Object Type: array - "attributes" : [{ - "type":"", #Type of the Attribute. Object Type: string - "name":"", #Name of the Attribute. Object Type: string - "value":"", #Value of the Attribute. Object Type: string -}], #Attributes. Object Type: array - "tacacs_service_params" : "" #variable unknown: , #Tacacs+ Service Params. Object Type: TacacsServiceParam - "dur_config" : "" #variable unknown: , #Downloadable User Role Configuration. Object Type: DURConfig - } - """ - url_path='/enforcement-profile/{enforcement_profile_id}' - dict_path={'enforcement_profile_id': enforcement_profile_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_by_enforcement_profile_id( + self, enforcement_profile_id="", body=({}) + ): + """ + Operation: Replace an Enforcement Profile + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: enforcement_profile_id, Description: Numeric ID of the Enforcement Profile + Required Body Parameters:['name', 'type'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Enforcement Profile. Object Type: string + "description" : "", #Description of the Enforcement Profile. Object Type: string + "type" : "", #Enforcement Profile Type. Object Type: string + "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string + "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "action" : "", #Enforcement Profile Action. Object Type: string + "device_group_list" : "", #Device Group List. Object Type: array + "attributes" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Attributes. Object Type: array + "tacacs_service_params" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Tacacs+ Service Params. Object Type: TacacsServiceParam + "dur_config" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Downloadable User Role Configuration. Object Type: DURConfig + + } + """ + url_path = "/enforcement-profile/{enforcement_profile_id}" + dict_path = {"enforcement_profile_id": enforcement_profile_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_by_enforcement_profile_id(self,enforcement_profile_id=""): + def delete_enforcement_profile_by_enforcement_profile_id( + self, enforcement_profile_id="" + ): """ Operation: Delete an Enforcement Profile HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: enforcement_profile_id, Description: Numeric ID of the Enforcement Profile """ - url_path='/enforcement-profile/{enforcement_profile_id}' - dict_path={'enforcement_profile_id': enforcement_profile_id} + url_path = "/enforcement-profile/{enforcement_profile_id}" + dict_path = {"enforcement_profile_id": enforcement_profile_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_name_by_name(self,name=""): + def get_enforcement_profile_name_by_name(self, name=""): """ Operation: Get an Enforcement Profile by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: name, Description: name of the enforcement profile """ - url_path='/enforcement-profile/name/{name}' - dict_path={'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_name_by_name(self,name="",body=({})): - """ - Operation: Update an Enforcement Profile by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: name, Description: name of the enforcement profile - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Enforcement Profile. Object Type: string - "description" : "", #Description of the Enforcement Profile. Object Type: string - "type" : "", #Enforcement Profile Type. Object Type: string - "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string - "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "action" : "", #Enforcement Profile Action. Object Type: string - "device_group_list" : "", #Device Group List. Object Type: array - "attributes" : [{ - "type":"", #Type of the Attribute. Object Type: string - "name":"", #Name of the Attribute. Object Type: string - "value":"", #Value of the Attribute. Object Type: string -}], #Attributes. Object Type: array - "tacacs_service_params" : "" #variable unknown: , #Tacacs+ Service Params. Object Type: TacacsServiceParam - "dur_config" : "" #variable unknown: , #Downloadable User Role Configuration. Object Type: DURConfig - } - """ - url_path='/enforcement-profile/name/{name}' - dict_path={'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile/name/{name}" + dict_path = {"name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_name_by_name(self, name="", body=({})): + """ + Operation: Update an Enforcement Profile by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: name, Description: name of the enforcement profile + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Enforcement Profile. Object Type: string + "description" : "", #Description of the Enforcement Profile. Object Type: string + "type" : "", #Enforcement Profile Type. Object Type: string + "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string + "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "action" : "", #Enforcement Profile Action. Object Type: string + "device_group_list" : "", #Device Group List. Object Type: array + "attributes" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Attributes. Object Type: array + "tacacs_service_params" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Tacacs+ Service Params. Object Type: TacacsServiceParam + "dur_config" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Downloadable User Role Configuration. Object Type: DURConfig + + } + """ + url_path = "/enforcement-profile/name/{name}" + dict_path = {"name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_name_by_name(self,name="",body=({})): - """ - Operation: Replace an Enforcement Profile by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: name, Description: name of the enforcement profile - Required Body Parameters:['name', 'type'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Enforcement Profile. Object Type: string - "description" : "", #Description of the Enforcement Profile. Object Type: string - "type" : "", #Enforcement Profile Type. Object Type: string - "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string - "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string - "action" : "", #Enforcement Profile Action. Object Type: string - "device_group_list" : "", #Device Group List. Object Type: array - "attributes" : [{ - "type":"", #Type of the Attribute. Object Type: string - "name":"", #Name of the Attribute. Object Type: string - "value":"", #Value of the Attribute. Object Type: string -}], #Attributes. Object Type: array - "tacacs_service_params" : "" #variable unknown: , #Tacacs+ Service Params. Object Type: TacacsServiceParam - "dur_config" : "" #variable unknown: , #Downloadable User Role Configuration. Object Type: DURConfig - } - """ - url_path='/enforcement-profile/name/{name}' - dict_path={'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_name_by_name(self, name="", body=({})): + """ + Operation: Replace an Enforcement Profile by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: name, Description: name of the enforcement profile + Required Body Parameters:['name', 'type'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Enforcement Profile. Object Type: string + "description" : "", #Description of the Enforcement Profile. Object Type: string + "type" : "", #Enforcement Profile Type. Object Type: string + "agent_template" : "", #Agent Enforcement Profile Template. Object Type: string + "post_auth_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "radius_dyn_authz_template" : "", #Post Authentication Enforcement Profile Template. Object Type: string + "action" : "", #Enforcement Profile Action. Object Type: string + "device_group_list" : "", #Device Group List. Object Type: array + "attributes" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Attributes. Object Type: array + "tacacs_service_params" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Tacacs+ Service Params. Object Type: TacacsServiceParam + "dur_config" : [{ + "type":"", #Type of the Attribute. Object Type: string + "name":"", #Name of the Attribute. Object Type: string + "value":"", #Value of the Attribute. Object Type: string + }], #Downloadable User Role Configuration. Object Type: DURConfig + + } + """ + url_path = "/enforcement-profile/name/{name}" + dict_path = {"name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_name_by_name(self,name=""): + def delete_enforcement_profile_name_by_name(self, name=""): """ Operation: Delete an Enforcement Profile by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: name, Description: name of the enforcement profile """ - url_path='/enforcement-profile/name/{name}' - dict_path={'name': name} + url_path = "/enforcement-profile/name/{name}" + dict_path = {"name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage Ethertype Access Control List - def get_enforcement_profile_dur_ethertype_access_control_list_by_product_name(self,product_name=""): + def get_enforcement_profile_dur_ethertype_access_control_list_by_product_name( + self, product_name="" + ): """ Operation: GET a list of Ethertype Access Control Lists HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' + url_path = ( + "/enforcement-profile-dur/ethertype-access-control-list/{product_name}" ) + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_ethertype_access_control_list_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_ethertype_access_control_list_by_product_name( + self, product_name="", body=({}) + ): """ - Operation: Add a Ethertype Access Control List - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Ethertype Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "ethertype_type":"", #Ethertype Type. Object Type: string - "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer - "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer -}], #Rules of the Ethertype Access Control List. Object Type: array - } + Operation: Add a Ethertype Access Control List + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Ethertype Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "ethertype_type":"", #Ethertype Type. Object Type: string + "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer + "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer + }], #Rules of the Ethertype Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}' - dict_path={'product_name': product_name} + url_path = ( + "/enforcement-profile-dur/ethertype-access-control-list/{product_name}" + ) + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id(self,product_name="",ethertype_access_control_list_id=""): + def get_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id( + self, product_name="", ethertype_access_control_list_id="" + ): """ Operation: Get a Ethertype Access Control List HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: ethertype_access_control_list_id, Description: Numeric ID of the Ethertype Access Control List """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}' - dict_path={'product_name': product_name, 'ethertype_access_control_list_id': ethertype_access_control_list_id} + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}" + dict_path = { + "product_name": product_name, + "ethertype_access_control_list_id": ethertype_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id(self,product_name="",ethertype_access_control_list_id="",body=({})): - """ - Operation: Update a Ethertype Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: ethertype_access_control_list_id, Description: Numeric ID of the Ethertype Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Ethertype Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "ethertype_type":"", #Ethertype Type. Object Type: string - "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer - "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer -}], #Rules of the Ethertype Access Control List. Object Type: array + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id( + self, product_name="", ethertype_access_control_list_id="", body=({}) + ): + """ + Operation: Update a Ethertype Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: ethertype_access_control_list_id, Description: Numeric ID of the Ethertype Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Ethertype Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "ethertype_type":"", #Ethertype Type. Object Type: string + "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer + "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer + }], #Rules of the Ethertype Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}" + dict_path = { + "product_name": product_name, + "ethertype_access_control_list_id": ethertype_access_control_list_id, } - """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}' - dict_path={'product_name': product_name, 'ethertype_access_control_list_id': ethertype_access_control_list_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id(self,product_name="",ethertype_access_control_list_id="",body=({})): + def replace_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id( + self, product_name="", ethertype_access_control_list_id="", body=({}) + ): """ - Operation: Replace a Ethertype Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: ethertype_access_control_list_id, Description: Numeric ID of the Ethertype Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Ethertype Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "ethertype_type":"", #Ethertype Type. Object Type: string - "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer - "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer -}], #Rules of the Ethertype Access Control List. Object Type: array - } + Operation: Replace a Ethertype Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: ethertype_access_control_list_id, Description: Numeric ID of the Ethertype Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Ethertype Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "ethertype_type":"", #Ethertype Type. Object Type: string + "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer + "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer + }], #Rules of the Ethertype Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}' - dict_path={'product_name': product_name, 'ethertype_access_control_list_id': ethertype_access_control_list_id} + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}" + dict_path = { + "product_name": product_name, + "ethertype_access_control_list_id": ethertype_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id(self,product_name="",ethertype_access_control_list_id=""): + def delete_enforcement_profile_dur_ethertype_access_control_list_by_product_name_ethertype_access_control_list_id( + self, product_name="", ethertype_access_control_list_id="" + ): """ Operation: Delete a Ethertype Access Control List HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: ethertype_access_control_list_id, Description: Numeric ID of the Ethertype Access Control List """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}' - dict_path={'product_name': product_name, 'ethertype_access_control_list_id': ethertype_access_control_list_id} + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/{ethertype_access_control_list_id}" + dict_path = { + "product_name": product_name, + "ethertype_access_control_list_id": ethertype_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Ethertype Access Control List by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Ethertype Access Control List """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ - Operation: Update a Ethertype Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Ethertype Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Ethertype Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "ethertype_type":"", #Ethertype Type. Object Type: string - "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer - "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer -}], #Rules of the Ethertype Access Control List. Object Type: array - } + Operation: Update a Ethertype Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Ethertype Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Ethertype Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "ethertype_type":"", #Ethertype Type. Object Type: string + "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer + "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer + }], #Rules of the Ethertype Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ - Operation: Replace a Ethertype Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Ethertype Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Ethertype Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "ethertype_type":"", #Ethertype Type. Object Type: string - "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer - "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer -}], #Rules of the Ethertype Access Control List. Object Type: array - } + Operation: Replace a Ethertype Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Ethertype Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Ethertype Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "ethertype_type":"", #Ethertype Type. Object Type: string + "ethertype_value":0, #Ethertype Value (0-65535). Object Type: integer + "subnet_bits":0, #Subnet Bits (0-65535). Object Type: integer + }], #Rules of the Ethertype Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_ethertype_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Ethertype Access Control List by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Ethertype Access Control List """ - url_path='/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/ethertype-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - # API Service: Manage MAC Access Control List - def get_enforcement_profile_dur_mac_access_control_list_by_product_name(self,product_name=""): + # API Service: Manage MAC Access Control List + def get_enforcement_profile_dur_mac_access_control_list_by_product_name( + self, product_name="" + ): """ Operation: GET a list of MAC Access Control Lists HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_mac_access_control_list_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_mac_access_control_list_by_product_name( + self, product_name="", body=({}) + ): """ - Operation: Add a MAC Access Control List - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the MAC Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "mac_address_type":"", #MAC Address Type. Object Type: string - "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string - "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string -}], #Rules of the MAC Access Control List. Object Type: array - } + Operation: Add a MAC Access Control List + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the MAC Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "mac_address_type":"", #MAC Address Type. Object Type: string + "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string + "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string + }], #Rules of the MAC Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id(self,product_name="",mac_access_control_list_id=""): + def get_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id( + self, product_name="", mac_access_control_list_id="" + ): """ Operation: Get a MAC Access Control List HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: mac_access_control_list_id, Description: Numeric ID of the MAC Access Control List """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}' - dict_path={'product_name': product_name, 'mac_access_control_list_id': mac_access_control_list_id} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}" + dict_path = { + "product_name": product_name, + "mac_access_control_list_id": mac_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id(self,product_name="",mac_access_control_list_id="",body=({})): - """ - Operation: Update some fields of a MAC Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: mac_access_control_list_id, Description: Numeric ID of the MAC Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the MAC Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "mac_address_type":"", #MAC Address Type. Object Type: string - "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string - "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string -}], #Rules of the MAC Access Control List. Object Type: array + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id( + self, product_name="", mac_access_control_list_id="", body=({}) + ): + """ + Operation: Update some fields of a MAC Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: mac_access_control_list_id, Description: Numeric ID of the MAC Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the MAC Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "mac_address_type":"", #MAC Address Type. Object Type: string + "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string + "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string + }], #Rules of the MAC Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}" + dict_path = { + "product_name": product_name, + "mac_access_control_list_id": mac_access_control_list_id, } - """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}' - dict_path={'product_name': product_name, 'mac_access_control_list_id': mac_access_control_list_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id(self,product_name="",mac_access_control_list_id="",body=({})): + def replace_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id( + self, product_name="", mac_access_control_list_id="", body=({}) + ): """ - Operation: Replace a MAC Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: mac_access_control_list_id, Description: Numeric ID of the MAC Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the MAC Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "mac_address_type":"", #MAC Address Type. Object Type: string - "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string - "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string -}], #Rules of the MAC Access Control List. Object Type: array - } + Operation: Replace a MAC Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: mac_access_control_list_id, Description: Numeric ID of the MAC Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the MAC Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "mac_address_type":"", #MAC Address Type. Object Type: string + "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string + "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string + }], #Rules of the MAC Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}' - dict_path={'product_name': product_name, 'mac_access_control_list_id': mac_access_control_list_id} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}" + dict_path = { + "product_name": product_name, + "mac_access_control_list_id": mac_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id(self,product_name="",mac_access_control_list_id=""): + def delete_enforcement_profile_dur_mac_access_control_list_by_product_name_mac_access_control_list_id( + self, product_name="", mac_access_control_list_id="" + ): """ Operation: Delete a MAC Access Control List HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: mac_access_control_list_id, Description: Numeric ID of the MAC Access Control List """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}' - dict_path={'product_name': product_name, 'mac_access_control_list_id': mac_access_control_list_id} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/{mac_access_control_list_id}" + dict_path = { + "product_name": product_name, + "mac_access_control_list_id": mac_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a MAC Access Control List by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the MAC Access Control List """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ - Operation: Update some fields of a MAC Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the MAC Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the MAC Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "mac_address_type":"", #MAC Address Type. Object Type: string - "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string - "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string -}], #Rules of the MAC Access Control List. Object Type: array - } + Operation: Update some fields of a MAC Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the MAC Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the MAC Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "mac_address_type":"", #MAC Address Type. Object Type: string + "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string + "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string + }], #Rules of the MAC Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ - Operation: Replace a MAC Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the MAC Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the MAC Access Control List. Object Type: string - "rules" : [{ - "action":"", #Action. Object Type: string - "mac_address_type":"", #MAC Address Type. Object Type: string - "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string - "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string -}], #Rules of the MAC Access Control List. Object Type: array - } + Operation: Replace a MAC Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the MAC Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the MAC Access Control List. Object Type: string + "rules" : [{ + "action":"", #Action. Object Type: string + "mac_address_type":"", #MAC Address Type. Object Type: string + "mac_address_value":"", #MAC Address Value (eg. AA:BB:CC:DD:EE:FF). Object Type: string + "subnet_bits":"", #Subnet Bits (eg. AA:BB:CC:DD:EE:FF). Object Type: string + }], #Rules of the MAC Access Control List. Object Type: array + + } """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_mac_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a MAC Access Control List by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the MAC Access Control List """ - url_path='/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/mac-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - # API Service: Manage NAT Pool - def get_enforcement_profile_dur_nat_pool_by_product_name(self,product_name=""): + # API Service: Manage NAT Pool + def get_enforcement_profile_dur_nat_pool_by_product_name(self, product_name=""): """ Operation: GET a list of NAT Pools HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_nat_pool_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_nat_pool_by_product_name( + self, product_name="", body=({}) + ): """ Operation: Add a NAT Pool HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1388,38 +1570,42 @@ def new_enforcement_profile_dur_nat_pool_by_product_name(self,product_name="",bo Required Body Parameters:['name', 'start_src_range', 'end_src_range'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the NAT Pool. Object Type: string "start_src_range" : "", #Start of source NAT range. Object Type: string "end_src_range" : "", #End of source NAT range. Object Type: string "destination_nat_ip_address" : "", #Destination NAT IP Address. Object Type: string + } """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id(self,product_name="",nat_pool_id=""): + def get_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id( + self, product_name="", nat_pool_id="" + ): """ Operation: Get a NAT Pool HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: nat_pool_id, Description: Numeric ID of the NAT Pool """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}' - dict_path={'product_name': product_name, 'nat_pool_id': nat_pool_id} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}" + dict_path = {"product_name": product_name, "nat_pool_id": nat_pool_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id(self,product_name="",nat_pool_id="",body=({})): + def update_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id( + self, product_name="", nat_pool_id="", body=({}) + ): """ Operation: Update some fields of a NAT Pool HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1428,23 +1614,27 @@ def update_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id(self,pro Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the NAT Pool. Object Type: string "start_src_range" : "", #Start of source NAT range. Object Type: string "end_src_range" : "", #End of source NAT range. Object Type: string "destination_nat_ip_address" : "", #Destination NAT IP Address. Object Type: string + } """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}' - dict_path={'product_name': product_name, 'nat_pool_id': nat_pool_id} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}" + dict_path = {"product_name": product_name, "nat_pool_id": nat_pool_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id(self,product_name="",nat_pool_id="",body=({})): + def replace_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id( + self, product_name="", nat_pool_id="", body=({}) + ): """ Operation: Replace a NAT Pool HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1453,53 +1643,57 @@ def replace_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id(self,pr Required Body Parameters:['name', 'start_src_range', 'end_src_range'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the NAT Pool. Object Type: string "start_src_range" : "", #Start of source NAT range. Object Type: string "end_src_range" : "", #End of source NAT range. Object Type: string "destination_nat_ip_address" : "", #Destination NAT IP Address. Object Type: string + } """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}' - dict_path={'product_name': product_name, 'nat_pool_id': nat_pool_id} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}" + dict_path = {"product_name": product_name, "nat_pool_id": nat_pool_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id(self,product_name="",nat_pool_id=""): + def delete_enforcement_profile_dur_nat_pool_by_product_name_nat_pool_id( + self, product_name="", nat_pool_id="" + ): """ Operation: Delete a NAT Pool HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: nat_pool_id, Description: Numeric ID of the NAT Pool """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}' - dict_path={'product_name': product_name, 'nat_pool_id': nat_pool_id} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/{nat_pool_id}" + dict_path = {"product_name": product_name, "nat_pool_id": nat_pool_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_nat_pool_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_nat_pool_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a NAT Pool by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the NAT Pool """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_nat_pool_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_nat_pool_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Update some fields of a NAT Pool by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1508,23 +1702,27 @@ def update_enforcement_profile_dur_nat_pool_by_product_name_name_name(self,produ Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the NAT Pool. Object Type: string "start_src_range" : "", #Start of source NAT range. Object Type: string "end_src_range" : "", #End of source NAT range. Object Type: string "destination_nat_ip_address" : "", #Destination NAT IP Address. Object Type: string + } """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_nat_pool_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_nat_pool_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Replace a NAT Pool by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1533,282 +1731,316 @@ def replace_enforcement_profile_dur_nat_pool_by_product_name_name_name(self,prod Required Body Parameters:['name', 'start_src_range', 'end_src_range'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the NAT Pool. Object Type: string "start_src_range" : "", #Start of source NAT range. Object Type: string "end_src_range" : "", #End of source NAT range. Object Type: string "destination_nat_ip_address" : "", #Destination NAT IP Address. Object Type: string + } """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_nat_pool_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_nat_pool_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a NAT Pool by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the NAT Pool """ - url_path='/enforcement-profile-dur/nat-pool/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/nat-pool/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage Net Destination - def get_enforcement_profile_dur_net_destination_by_product_name(self,product_name=""): + def get_enforcement_profile_dur_net_destination_by_product_name( + self, product_name="" + ): """ Operation: GET a list of Net Destinations HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/net-destination/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/net-destination/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_net_destination_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_net_destination_by_product_name( + self, product_name="", body=({}) + ): """ - Operation: Add a Net Destination - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name', 'rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Net Destination. Object Type: string - "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean - "rules" : [{ - "rule_type":"", #Rule Type. Object Type: string - "ip_address":"", #IP Address. Object Type: string - "netmask":"", #Netmask. Object Type: string - "end_ip_address":"", #End IP Address. Object Type: string - "host_name":"", #Host Name or Domain. Object Type: string - "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer -}], #Rules for the Net Destination. Object Type: array - } + Operation: Add a Net Destination + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name', 'rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Net Destination. Object Type: string + "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean + "rules" : [{ + "rule_type":"", #Rule Type. Object Type: string + "ip_address":"", #IP Address. Object Type: string + "netmask":"", #Netmask. Object Type: string + "end_ip_address":"", #End IP Address. Object Type: string + "host_name":"", #Host Name or Domain. Object Type: string + "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer + }], #Rules for the Net Destination. Object Type: array + + } """ - url_path='/enforcement-profile-dur/net-destination/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/net-destination/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_net_destination_by_product_name_net_destination_id(self,product_name="",net_destination_id=""): + def get_enforcement_profile_dur_net_destination_by_product_name_net_destination_id( + self, product_name="", net_destination_id="" + ): """ Operation: Get a Net Destination HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: net_destination_id, Description: Numeric ID of the Net Destination """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}' - dict_path={'product_name': product_name, 'net_destination_id': net_destination_id} + url_path = "/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}" + dict_path = { + "product_name": product_name, + "net_destination_id": net_destination_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_net_destination_by_product_name_net_destination_id(self,product_name="",net_destination_id="",body=({})): - """ - Operation: Update some fields of a Net Destination - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: net_destination_id, Description: Numeric ID of the Net Destination - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Net Destination. Object Type: string - "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean - "rules" : [{ - "rule_type":"", #Rule Type. Object Type: string - "ip_address":"", #IP Address. Object Type: string - "netmask":"", #Netmask. Object Type: string - "end_ip_address":"", #End IP Address. Object Type: string - "host_name":"", #Host Name or Domain. Object Type: string - "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer -}], #Rules for the Net Destination. Object Type: array + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_net_destination_by_product_name_net_destination_id( + self, product_name="", net_destination_id="", body=({}) + ): + """ + Operation: Update some fields of a Net Destination + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: net_destination_id, Description: Numeric ID of the Net Destination + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Net Destination. Object Type: string + "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean + "rules" : [{ + "rule_type":"", #Rule Type. Object Type: string + "ip_address":"", #IP Address. Object Type: string + "netmask":"", #Netmask. Object Type: string + "end_ip_address":"", #End IP Address. Object Type: string + "host_name":"", #Host Name or Domain. Object Type: string + "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer + }], #Rules for the Net Destination. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}" + dict_path = { + "product_name": product_name, + "net_destination_id": net_destination_id, } - """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}' - dict_path={'product_name': product_name, 'net_destination_id': net_destination_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_net_destination_by_product_name_net_destination_id(self,product_name="",net_destination_id="",body=({})): - """ - Operation: Replace a Net Destination - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: net_destination_id, Description: Numeric ID of the Net Destination - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Net Destination. Object Type: string - "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean - "rules" : [{ - "rule_type":"", #Rule Type. Object Type: string - "ip_address":"", #IP Address. Object Type: string - "netmask":"", #Netmask. Object Type: string - "end_ip_address":"", #End IP Address. Object Type: string - "host_name":"", #Host Name or Domain. Object Type: string - "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer -}], #Rules for the Net Destination. Object Type: array + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_net_destination_by_product_name_net_destination_id( + self, product_name="", net_destination_id="", body=({}) + ): + """ + Operation: Replace a Net Destination + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: net_destination_id, Description: Numeric ID of the Net Destination + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Net Destination. Object Type: string + "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean + "rules" : [{ + "rule_type":"", #Rule Type. Object Type: string + "ip_address":"", #IP Address. Object Type: string + "netmask":"", #Netmask. Object Type: string + "end_ip_address":"", #End IP Address. Object Type: string + "host_name":"", #Host Name or Domain. Object Type: string + "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer + }], #Rules for the Net Destination. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}" + dict_path = { + "product_name": product_name, + "net_destination_id": net_destination_id, } - """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}' - dict_path={'product_name': product_name, 'net_destination_id': net_destination_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_net_destination_by_product_name_net_destination_id(self,product_name="",net_destination_id=""): + def delete_enforcement_profile_dur_net_destination_by_product_name_net_destination_id( + self, product_name="", net_destination_id="" + ): """ Operation: Delete a Net Destination HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: net_destination_id, Description: Numeric ID of the Net Destination """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}' - dict_path={'product_name': product_name, 'net_destination_id': net_destination_id} + url_path = "/enforcement-profile-dur/net-destination/{product_name}/{net_destination_id}" + dict_path = { + "product_name": product_name, + "net_destination_id": net_destination_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_net_destination_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_net_destination_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Net Destination by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Net Destination """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_net_destination_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Update some fields of a Net Destination by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Net Destination - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Net Destination. Object Type: string - "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean - "rules" : [{ - "rule_type":"", #Rule Type. Object Type: string - "ip_address":"", #IP Address. Object Type: string - "netmask":"", #Netmask. Object Type: string - "end_ip_address":"", #End IP Address. Object Type: string - "host_name":"", #Host Name or Domain. Object Type: string - "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer -}], #Rules for the Net Destination. Object Type: array - } - """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/net-destination/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_net_destination_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Update some fields of a Net Destination by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Net Destination + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Net Destination. Object Type: string + "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean + "rules" : [{ + "rule_type":"", #Rule Type. Object Type: string + "ip_address":"", #IP Address. Object Type: string + "netmask":"", #Netmask. Object Type: string + "end_ip_address":"", #End IP Address. Object Type: string + "host_name":"", #Host Name or Domain. Object Type: string + "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer + }], #Rules for the Net Destination. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/net-destination/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_net_destination_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_net_destination_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ - Operation: Replace a Net Destination by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Net Destination - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Net Destination. Object Type: string - "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean - "rules" : [{ - "rule_type":"", #Rule Type. Object Type: string - "ip_address":"", #IP Address. Object Type: string - "netmask":"", #Netmask. Object Type: string - "end_ip_address":"", #End IP Address. Object Type: string - "host_name":"", #Host Name or Domain. Object Type: string - "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer -}], #Rules for the Net Destination. Object Type: array - } + Operation: Replace a Net Destination by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Net Destination + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Net Destination. Object Type: string + "invert" : False, #Invert for Mobility Access Switch and Mobility Controller Net Destination. Object Type: boolean + "rules" : [{ + "rule_type":"", #Rule Type. Object Type: string + "ip_address":"", #IP Address. Object Type: string + "netmask":"", #Netmask. Object Type: string + "end_ip_address":"", #End IP Address. Object Type: string + "host_name":"", #Host Name or Domain. Object Type: string + "position":0, #Position (1-220) for ArubaOS-Switch Net Destination rule. Object Type: integer + }], #Rules for the Net Destination. Object Type: array + + } """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/net-destination/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_net_destination_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_net_destination_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Net Destination by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Net Destination """ - url_path='/enforcement-profile-dur/net-destination/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/net-destination/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage Net Services - def get_enforcement_profile_dur_net_service_by_product_name(self,product_name=""): + def get_enforcement_profile_dur_net_service_by_product_name(self, product_name=""): """ Operation: GET a list of Net Services HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/net-service/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/net-service/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_net_service_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_net_service_by_product_name( + self, product_name="", body=({}) + ): """ Operation: Add a Net Service HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1816,6 +2048,7 @@ def new_enforcement_profile_dur_net_service_by_product_name(self,product_name="" Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Net Service. Object Type: string "description" : "", #Description of the Net Service. Object Type: string @@ -1826,33 +2059,38 @@ def new_enforcement_profile_dur_net_service_by_product_name(self,product_name="" "max_port" : 0, #Max Port of the Net Service (1-65535). Object Type: integer "ip_protocol_number" : 0, #IP Protocol Number of the Net Service (0-255). Object Type: integer "application_level_gateway" : "", #Application Level Gateway of the Net Service. Object Type: string + } """ - url_path='/enforcement-profile-dur/net-service/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/net-service/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_net_service_by_product_name_net_service_id(self,product_name="",net_service_id=""): + def get_enforcement_profile_dur_net_service_by_product_name_net_service_id( + self, product_name="", net_service_id="" + ): """ Operation: Get a Net Service HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: net_service_id, Description: Numeric ID of the Net Service """ - url_path='/enforcement-profile-dur/net-service/{product_name}/{net_service_id}' - dict_path={'product_name': product_name, 'net_service_id': net_service_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' + url_path = ( + "/enforcement-profile-dur/net-service/{product_name}/{net_service_id}" ) + dict_path = {"product_name": product_name, "net_service_id": net_service_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_net_service_by_product_name_net_service_id(self,product_name="",net_service_id="",body=({})): + def update_enforcement_profile_dur_net_service_by_product_name_net_service_id( + self, product_name="", net_service_id="", body=({}) + ): """ Operation: Update some fields of a Net Service HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1861,6 +2099,7 @@ def update_enforcement_profile_dur_net_service_by_product_name_net_service_id(se Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Net Service. Object Type: string "description" : "", #Description of the Net Service. Object Type: string @@ -1871,18 +2110,23 @@ def update_enforcement_profile_dur_net_service_by_product_name_net_service_id(se "max_port" : 0, #Max Port of the Net Service (1-65535). Object Type: integer "ip_protocol_number" : 0, #IP Protocol Number of the Net Service (0-255). Object Type: integer "application_level_gateway" : "", #Application Level Gateway of the Net Service. Object Type: string + } """ - url_path='/enforcement-profile-dur/net-service/{product_name}/{net_service_id}' - dict_path={'product_name': product_name, 'net_service_id': net_service_id} + url_path = ( + "/enforcement-profile-dur/net-service/{product_name}/{net_service_id}" + ) + dict_path = {"product_name": product_name, "net_service_id": net_service_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_net_service_by_product_name_net_service_id(self,product_name="",net_service_id="",body=({})): + def replace_enforcement_profile_dur_net_service_by_product_name_net_service_id( + self, product_name="", net_service_id="", body=({}) + ): """ Operation: Replace a Net Service HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1891,6 +2135,7 @@ def replace_enforcement_profile_dur_net_service_by_product_name_net_service_id(s Required Body Parameters:['name', 'description', 'protocol'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Net Service. Object Type: string "description" : "", #Description of the Net Service. Object Type: string @@ -1901,48 +2146,55 @@ def replace_enforcement_profile_dur_net_service_by_product_name_net_service_id(s "max_port" : 0, #Max Port of the Net Service (1-65535). Object Type: integer "ip_protocol_number" : 0, #IP Protocol Number of the Net Service (0-255). Object Type: integer "application_level_gateway" : "", #Application Level Gateway of the Net Service. Object Type: string + } """ - url_path='/enforcement-profile-dur/net-service/{product_name}/{net_service_id}' - dict_path={'product_name': product_name, 'net_service_id': net_service_id} + url_path = ( + "/enforcement-profile-dur/net-service/{product_name}/{net_service_id}" + ) + dict_path = {"product_name": product_name, "net_service_id": net_service_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_net_service_by_product_name_net_service_id(self,product_name="",net_service_id=""): + def delete_enforcement_profile_dur_net_service_by_product_name_net_service_id( + self, product_name="", net_service_id="" + ): """ Operation: Delete a Net Service HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: net_service_id, Description: Numeric ID of the Net Service """ - url_path='/enforcement-profile-dur/net-service/{product_name}/{net_service_id}' - dict_path={'product_name': product_name, 'net_service_id': net_service_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' + url_path = ( + "/enforcement-profile-dur/net-service/{product_name}/{net_service_id}" ) + dict_path = {"product_name": product_name, "net_service_id": net_service_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_net_service_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_net_service_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Net Service by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Net Service """ - url_path='/enforcement-profile-dur/net-service/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/net-service/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_net_service_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_net_service_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Update some fields of a Net Service by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1951,6 +2203,7 @@ def update_enforcement_profile_dur_net_service_by_product_name_name_name(self,pr Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Net Service. Object Type: string "description" : "", #Description of the Net Service. Object Type: string @@ -1961,18 +2214,21 @@ def update_enforcement_profile_dur_net_service_by_product_name_name_name(self,pr "max_port" : 0, #Max Port of the Net Service (1-65535). Object Type: integer "ip_protocol_number" : 0, #IP Protocol Number of the Net Service (0-255). Object Type: integer "application_level_gateway" : "", #Application Level Gateway of the Net Service. Object Type: string + } """ - url_path='/enforcement-profile-dur/net-service/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/net-service/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_net_service_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_net_service_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Replace a Net Service by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -1981,6 +2237,7 @@ def replace_enforcement_profile_dur_net_service_by_product_name_name_name(self,p Required Body Parameters:['name', 'description', 'protocol'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Net Service. Object Type: string "description" : "", #Description of the Net Service. Object Type: string @@ -1991,48 +2248,51 @@ def replace_enforcement_profile_dur_net_service_by_product_name_name_name(self,p "max_port" : 0, #Max Port of the Net Service (1-65535). Object Type: integer "ip_protocol_number" : 0, #IP Protocol Number of the Net Service (0-255). Object Type: integer "application_level_gateway" : "", #Application Level Gateway of the Net Service. Object Type: string + } """ - url_path='/enforcement-profile-dur/net-service/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/net-service/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_net_service_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_net_service_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Net Service by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Net Service """ - url_path='/enforcement-profile-dur/net-service/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/net-service/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - # API Service: Manage Policer Profile - def get_enforcement_profile_dur_policer_profile_by_product_name(self,product_name=""): + # API Service: Manage Policer Profile + def get_enforcement_profile_dur_policer_profile_by_product_name( + self, product_name="" + ): """ Operation: GET a list of Policer Profiles HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_policer_profile_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_policer_profile_by_product_name( + self, product_name="", body=({}) + ): """ Operation: Add a Policer Profile HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2040,6 +2300,7 @@ def new_enforcement_profile_dur_policer_profile_by_product_name(self,product_nam Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Policer Profile. Object Type: string "cbs" : 0, #CBS (Bytes) of the Policer Profile. Object Type: integer @@ -2049,33 +2310,39 @@ def new_enforcement_profile_dur_policer_profile_by_product_name(self,product_nam "exceed_qos_profile" : "", #Exceed QoS Profile of the Policer Profile. Object Type: string "violate_action" : "", #Violate Action of the Policer Profile. Object Type: string "violate_qos_profile" : "", #Violate QoS Profile of the Policer Profile. Object Type: string + } """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id(self,product_name="",policer_profile_id=""): + def get_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id( + self, product_name="", policer_profile_id="" + ): """ Operation: Get a Policer Profile HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: policer_profile_id, Description: Numeric ID of the Policer Profile """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}' - dict_path={'product_name': product_name, 'policer_profile_id': policer_profile_id} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}" + dict_path = { + "product_name": product_name, + "policer_profile_id": policer_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id(self,product_name="",policer_profile_id="",body=({})): + def update_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id( + self, product_name="", policer_profile_id="", body=({}) + ): """ Operation: Update some fields of a Policer Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2084,6 +2351,7 @@ def update_enforcement_profile_dur_policer_profile_by_product_name_policer_profi Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Policer Profile. Object Type: string "cbs" : 0, #CBS (Bytes) of the Policer Profile. Object Type: integer @@ -2093,18 +2361,24 @@ def update_enforcement_profile_dur_policer_profile_by_product_name_policer_profi "exceed_qos_profile" : "", #Exceed QoS Profile of the Policer Profile. Object Type: string "violate_action" : "", #Violate Action of the Policer Profile. Object Type: string "violate_qos_profile" : "", #Violate QoS Profile of the Policer Profile. Object Type: string + } """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}' - dict_path={'product_name': product_name, 'policer_profile_id': policer_profile_id} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}" + dict_path = { + "product_name": product_name, + "policer_profile_id": policer_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id(self,product_name="",policer_profile_id="",body=({})): + def replace_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id( + self, product_name="", policer_profile_id="", body=({}) + ): """ Operation: Replace a Policer Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2113,6 +2387,7 @@ def replace_enforcement_profile_dur_policer_profile_by_product_name_policer_prof Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Policer Profile. Object Type: string "cbs" : 0, #CBS (Bytes) of the Policer Profile. Object Type: integer @@ -2122,48 +2397,57 @@ def replace_enforcement_profile_dur_policer_profile_by_product_name_policer_prof "exceed_qos_profile" : "", #Exceed QoS Profile of the Policer Profile. Object Type: string "violate_action" : "", #Violate Action of the Policer Profile. Object Type: string "violate_qos_profile" : "", #Violate QoS Profile of the Policer Profile. Object Type: string + } """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}' - dict_path={'product_name': product_name, 'policer_profile_id': policer_profile_id} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}" + dict_path = { + "product_name": product_name, + "policer_profile_id": policer_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id(self,product_name="",policer_profile_id=""): + def delete_enforcement_profile_dur_policer_profile_by_product_name_policer_profile_id( + self, product_name="", policer_profile_id="" + ): """ Operation: Delete a Policer Profile HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: policer_profile_id, Description: Numeric ID of the Policer Profile """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}' - dict_path={'product_name': product_name, 'policer_profile_id': policer_profile_id} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/{policer_profile_id}" + dict_path = { + "product_name": product_name, + "policer_profile_id": policer_profile_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_policer_profile_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_policer_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Policer Profile by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Policer Profile """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_policer_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_policer_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Update some fields of a Policer Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2172,6 +2456,7 @@ def update_enforcement_profile_dur_policer_profile_by_product_name_name_name(sel Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Policer Profile. Object Type: string "cbs" : 0, #CBS (Bytes) of the Policer Profile. Object Type: integer @@ -2181,18 +2466,21 @@ def update_enforcement_profile_dur_policer_profile_by_product_name_name_name(sel "exceed_qos_profile" : "", #Exceed QoS Profile of the Policer Profile. Object Type: string "violate_action" : "", #Violate Action of the Policer Profile. Object Type: string "violate_qos_profile" : "", #Violate QoS Profile of the Policer Profile. Object Type: string + } """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_policer_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_policer_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Replace a Policer Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2201,6 +2489,7 @@ def replace_enforcement_profile_dur_policer_profile_by_product_name_name_name(se Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Policer Profile. Object Type: string "cbs" : 0, #CBS (Bytes) of the Policer Profile. Object Type: integer @@ -2210,302 +2499,321 @@ def replace_enforcement_profile_dur_policer_profile_by_product_name_name_name(se "exceed_qos_profile" : "", #Exceed QoS Profile of the Policer Profile. Object Type: string "violate_action" : "", #Violate Action of the Policer Profile. Object Type: string "violate_qos_profile" : "", #Violate QoS Profile of the Policer Profile. Object Type: string + } """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_policer_profile_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_policer_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Policer Profile by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Policer Profile """ - url_path='/enforcement-profile-dur/policer-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/policer-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage Policy - def get_enforcement_profile_dur_policy_by_product_name(self,product_name=""): + def get_enforcement_profile_dur_policy_by_product_name(self, product_name=""): """ Operation: GET a list of Policies HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/policy/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def new_enforcement_profile_dur_policy_by_product_name(self,product_name="",body=({})): - """ - Operation: Add a Policy - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name', 'rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Policy. Object Type: string - "rules" : [{ - "number":0, #Number. Object Type: integer - "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string - "class_name":"", #Class Name. Object Type: string - "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "ip_precedence":0, #IP Precedence (0-7). Object Type: integer - "priority":0, #Priority (0-7). Object Type: integer - "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer - "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer - "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer - "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string - "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer -}], #Rules of the Policy. Object Type: array - } - """ - url_path='/enforcement-profile-dur/policy/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/policy/{product_name}" + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def new_enforcement_profile_dur_policy_by_product_name( + self, product_name="", body=({}) + ): + """ + Operation: Add a Policy + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name', 'rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Policy. Object Type: string + "rules" : [{ + "number":0, #Number. Object Type: integer + "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string + "class_name":"", #Class Name. Object Type: string + "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "ip_precedence":0, #IP Precedence (0-7). Object Type: integer + "priority":0, #Priority (0-7). Object Type: integer + "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer + "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer + "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer + "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string + "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer + }], #Rules of the Policy. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/policy/{product_name}" + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_policy_by_product_name_policy_id(self,product_name="",policy_id=""): + def get_enforcement_profile_dur_policy_by_product_name_policy_id( + self, product_name="", policy_id="" + ): """ Operation: Get a Policy HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: policy_id, Description: Numeric ID of the Policy """ - url_path='/enforcement-profile-dur/policy/{product_name}/{policy_id}' - dict_path={'product_name': product_name, 'policy_id': policy_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_policy_by_product_name_policy_id(self,product_name="",policy_id="",body=({})): - """ - Operation: Update a Policy - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: policy_id, Description: Numeric ID of the Policy - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Policy. Object Type: string - "rules" : [{ - "number":0, #Number. Object Type: integer - "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string - "class_name":"", #Class Name. Object Type: string - "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "ip_precedence":0, #IP Precedence (0-7). Object Type: integer - "priority":0, #Priority (0-7). Object Type: integer - "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer - "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer - "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer - "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string - "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer -}], #Rules of the Policy. Object Type: array - } - """ - url_path='/enforcement-profile-dur/policy/{product_name}/{policy_id}' - dict_path={'product_name': product_name, 'policy_id': policy_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/policy/{product_name}/{policy_id}" + dict_path = {"product_name": product_name, "policy_id": policy_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_policy_by_product_name_policy_id( + self, product_name="", policy_id="", body=({}) + ): + """ + Operation: Update a Policy + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: policy_id, Description: Numeric ID of the Policy + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Policy. Object Type: string + "rules" : [{ + "number":0, #Number. Object Type: integer + "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string + "class_name":"", #Class Name. Object Type: string + "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "ip_precedence":0, #IP Precedence (0-7). Object Type: integer + "priority":0, #Priority (0-7). Object Type: integer + "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer + "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer + "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer + "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string + "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer + }], #Rules of the Policy. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/policy/{product_name}/{policy_id}" + dict_path = {"product_name": product_name, "policy_id": policy_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_policy_by_product_name_policy_id(self,product_name="",policy_id="",body=({})): - """ - Operation: Replace a Policy - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: policy_id, Description: Numeric ID of the Policy - Required Body Parameters:['name', 'rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Policy. Object Type: string - "rules" : [{ - "number":0, #Number. Object Type: integer - "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string - "class_name":"", #Class Name. Object Type: string - "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "ip_precedence":0, #IP Precedence (0-7). Object Type: integer - "priority":0, #Priority (0-7). Object Type: integer - "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer - "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer - "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer - "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string - "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer -}], #Rules of the Policy. Object Type: array - } - """ - url_path='/enforcement-profile-dur/policy/{product_name}/{policy_id}' - dict_path={'product_name': product_name, 'policy_id': policy_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_policy_by_product_name_policy_id( + self, product_name="", policy_id="", body=({}) + ): + """ + Operation: Replace a Policy + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: policy_id, Description: Numeric ID of the Policy + Required Body Parameters:['name', 'rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Policy. Object Type: string + "rules" : [{ + "number":0, #Number. Object Type: integer + "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string + "class_name":"", #Class Name. Object Type: string + "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "ip_precedence":0, #IP Precedence (0-7). Object Type: integer + "priority":0, #Priority (0-7). Object Type: integer + "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer + "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer + "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer + "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string + "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer + }], #Rules of the Policy. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/policy/{product_name}/{policy_id}" + dict_path = {"product_name": product_name, "policy_id": policy_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_policy_by_product_name_policy_id(self,product_name="",policy_id=""): + def delete_enforcement_profile_dur_policy_by_product_name_policy_id( + self, product_name="", policy_id="" + ): """ Operation: Delete a Policy HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: policy_id, Description: Numeric ID of the Policy """ - url_path='/enforcement-profile-dur/policy/{product_name}/{policy_id}' - dict_path={'product_name': product_name, 'policy_id': policy_id} + url_path = "/enforcement-profile-dur/policy/{product_name}/{policy_id}" + dict_path = {"product_name": product_name, "policy_id": policy_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_policy_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_policy_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Policy by name - HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Policy - """ - url_path='/enforcement-profile-dur/policy/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_policy_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Update a Policy by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Policy - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Policy. Object Type: string - "rules" : [{ - "number":0, #Number. Object Type: integer - "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string - "class_name":"", #Class Name. Object Type: string - "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "ip_precedence":0, #IP Precedence (0-7). Object Type: integer - "priority":0, #Priority (0-7). Object Type: integer - "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer - "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer - "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer - "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string - "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer -}], #Rules of the Policy. Object Type: array - } - """ - url_path='/enforcement-profile-dur/policy/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - body = _remove_empty_keys(keys=body) - return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_policy_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Replace a Policy by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Policy - Required Body Parameters:['name', 'rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Policy. Object Type: string - "rules" : [{ - "number":0, #Number. Object Type: integer - "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string - "class_name":"", #Class Name. Object Type: string - "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string - "dscp":0, #DSCP (0-63). Object Type: integer - "ip_precedence":0, #IP Precedence (0-7). Object Type: integer - "priority":0, #Priority (0-7). Object Type: integer - "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer - "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer - "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer - "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string - "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer -}], #Rules of the Policy. Object Type: array - } + HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Policy """ - url_path='/enforcement-profile-dur/policy/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/policy/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_policy_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Update a Policy by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Policy + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Policy. Object Type: string + "rules" : [{ + "number":0, #Number. Object Type: integer + "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string + "class_name":"", #Class Name. Object Type: string + "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "ip_precedence":0, #IP Precedence (0-7). Object Type: integer + "priority":0, #Priority (0-7). Object Type: integer + "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer + "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer + "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer + "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string + "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer + }], #Rules of the Policy. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/policy/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_policy_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Replace a Policy by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Policy + Required Body Parameters:['name', 'rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Policy. Object Type: string + "rules" : [{ + "number":0, #Number. Object Type: integer + "class_type":"", #Class Type. ipv4 only applies to ArubaOS-Switch policy and ip only applies to AOS-CX policy. Object Type: string + "class_name":"", #Class Name. Object Type: string + "action":"", #Action. deny only applies to ArubaOS-Switch policy and drop only applies to AOS-CX policy. Object Type: string + "dscp":0, #DSCP (0-63). Object Type: integer + "ip_precedence":0, #IP Precedence (0-7). Object Type: integer + "priority":0, #Priority (0-7). Object Type: integer + "rate_limit":0, #Rate Limit in kbps for ArubaOS-Switch policy (0-10000000). Object Type: integer + "committed_information_rate":0, #Committed Information Rate for AOS-CX policy (1-4294967295). Object Type: integer + "committed_burst_size":0, #Committed Burst Size for AOS-CX policy (1-4294967295). Object Type: integer + "exceed_action":"", #Exceed Action for AOS-CX policy. Object Type: string + "priority_code_point":0, #Priority Code Point for AOS-CX policy (0-7). Object Type: integer + }], #Rules of the Policy. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/policy/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + body = _remove_empty_keys(keys=body) + return ClearPassAPILogin._send_request( + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_policy_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_policy_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Policy by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Policy """ - url_path='/enforcement-profile-dur/policy/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/policy/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage QoS Profiles - def get_enforcement_profile_dur_qos_profile_by_product_name(self,product_name=""): + def get_enforcement_profile_dur_qos_profile_by_product_name(self, product_name=""): """ Operation: GET a list of QoS Profiles HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/qos-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_qos_profile_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_qos_profile_by_product_name( + self, product_name="", body=({}) + ): """ Operation: Add a QoS Profile HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2513,39 +2821,45 @@ def new_enforcement_profile_dur_qos_profile_by_product_name(self,product_name="" Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the QoS Profile. Object Type: string "traffic_class" : 0, #Traffic Class of the QoS Profile (0-7). Object Type: integer "drop_precedence" : "", #Drop Precedence of the QoS Profile. Object Type: string "dscp" : 0, #DSCP of the QoS Profile (0-63). Object Type: integer "dot1p" : 0, #802.1p of the QoS Profile (0-7). Object Type: integer + } """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/qos-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id(self,product_name="",qos_profile_id=""): + def get_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id( + self, product_name="", qos_profile_id="" + ): """ Operation: Get a QoS Profile HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: qos_profile_id, Description: Numeric ID of the QoS Profile """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}' - dict_path={'product_name': product_name, 'qos_profile_id': qos_profile_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' + url_path = ( + "/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}" ) + dict_path = {"product_name": product_name, "qos_profile_id": qos_profile_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id(self,product_name="",qos_profile_id="",body=({})): + def update_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id( + self, product_name="", qos_profile_id="", body=({}) + ): """ Operation: Update some fields of a QoS Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2554,24 +2868,30 @@ def update_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id(se Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the QoS Profile. Object Type: string "traffic_class" : 0, #Traffic Class of the QoS Profile (0-7). Object Type: integer "drop_precedence" : "", #Drop Precedence of the QoS Profile. Object Type: string "dscp" : 0, #DSCP of the QoS Profile (0-63). Object Type: integer "dot1p" : 0, #802.1p of the QoS Profile (0-7). Object Type: integer + } """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}' - dict_path={'product_name': product_name, 'qos_profile_id': qos_profile_id} + url_path = ( + "/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}" + ) + dict_path = {"product_name": product_name, "qos_profile_id": qos_profile_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id(self,product_name="",qos_profile_id="",body=({})): + def replace_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id( + self, product_name="", qos_profile_id="", body=({}) + ): """ Operation: Replace a QoS Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2580,54 +2900,62 @@ def replace_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id(s Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the QoS Profile. Object Type: string "traffic_class" : 0, #Traffic Class of the QoS Profile (0-7). Object Type: integer "drop_precedence" : "", #Drop Precedence of the QoS Profile. Object Type: string "dscp" : 0, #DSCP of the QoS Profile (0-63). Object Type: integer "dot1p" : 0, #802.1p of the QoS Profile (0-7). Object Type: integer + } """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}' - dict_path={'product_name': product_name, 'qos_profile_id': qos_profile_id} + url_path = ( + "/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}" + ) + dict_path = {"product_name": product_name, "qos_profile_id": qos_profile_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id(self,product_name="",qos_profile_id=""): + def delete_enforcement_profile_dur_qos_profile_by_product_name_qos_profile_id( + self, product_name="", qos_profile_id="" + ): """ Operation: Delete a QoS Profile HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: qos_profile_id, Description: Numeric ID of the QoS Profile """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}' - dict_path={'product_name': product_name, 'qos_profile_id': qos_profile_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' + url_path = ( + "/enforcement-profile-dur/qos-profile/{product_name}/{qos_profile_id}" ) + dict_path = {"product_name": product_name, "qos_profile_id": qos_profile_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_qos_profile_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_qos_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a QoS Profile by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the QoS Profile """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/qos-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_qos_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_qos_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Update some fields of a QoS Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2636,24 +2964,28 @@ def update_enforcement_profile_dur_qos_profile_by_product_name_name_name(self,pr Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the QoS Profile. Object Type: string "traffic_class" : 0, #Traffic Class of the QoS Profile (0-7). Object Type: integer "drop_precedence" : "", #Drop Precedence of the QoS Profile. Object Type: string "dscp" : 0, #DSCP of the QoS Profile (0-63). Object Type: integer "dot1p" : 0, #802.1p of the QoS Profile (0-7). Object Type: integer + } """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/qos-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_qos_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_qos_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Replace a QoS Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -2662,936 +2994,1024 @@ def replace_enforcement_profile_dur_qos_profile_by_product_name_name_name(self,p Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the QoS Profile. Object Type: string "traffic_class" : 0, #Traffic Class of the QoS Profile (0-7). Object Type: integer "drop_precedence" : "", #Drop Precedence of the QoS Profile. Object Type: string "dscp" : 0, #DSCP of the QoS Profile (0-63). Object Type: integer "dot1p" : 0, #802.1p of the QoS Profile (0-7). Object Type: integer + } """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/qos-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_qos_profile_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_qos_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a QoS Profile by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the QoS Profile """ - url_path='/enforcement-profile-dur/qos-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/qos-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - # API Service: Manage Session Access Control List - def get_enforcement_profile_dur_session_access_control_list_by_product_name(self,product_name=""): + # API Service: Manage Session Access Control List + def get_enforcement_profile_dur_session_access_control_list_by_product_name( + self, product_name="" + ): """ Operation: GET a list of Session Access Control Lists HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def new_enforcement_profile_dur_session_access_control_list_by_product_name(self,product_name="",body=({})): - """ - Operation: Add a Session Access Control List - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Session Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number (0-255). Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer - "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer - "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer - "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer - "action":"", #Action. Object Type: string - "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string - "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer - "network_name":"", #Name of Network in FQDN format. Object Type: string - "dual_nat_pool":"", #Dual NAT Pool. Object Type: string - "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer - "src_nat_pool":"", #Source NAT Pool. Object Type: string - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "mirror":"", #Mirror. Object Type: string - "position":0, #Position (1-2000). Object Type: integer - "queue_priority":"", #Queue Priority. Object Type: string - "time_range":"", #Time Range. Object Type: string - "tos":0, #TOS (0-63). Object Type: integer -}], #Rules of the Session Access Control List. Object Type: array - } - """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}" + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def new_enforcement_profile_dur_session_access_control_list_by_product_name( + self, product_name="", body=({}) + ): + """ + Operation: Add a Session Access Control List + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Session Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number (0-255). Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer + "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer + "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer + "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer + "action":"", #Action. Object Type: string + "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string + "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer + "network_name":"", #Name of Network in FQDN format. Object Type: string + "dual_nat_pool":"", #Dual NAT Pool. Object Type: string + "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer + "src_nat_pool":"", #Source NAT Pool. Object Type: string + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "mirror":"", #Mirror. Object Type: string + "position":0, #Position (1-2000). Object Type: integer + "queue_priority":"", #Queue Priority. Object Type: string + "time_range":"", #Time Range. Object Type: string + "tos":0, #TOS (0-63). Object Type: integer + }], #Rules of the Session Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}" + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id(self,product_name="",session_access_control_list_id=""): + def get_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id( + self, product_name="", session_access_control_list_id="" + ): """ Operation: Get a Session Access Control List HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: session_access_control_list_id, Description: Numeric ID of the Session Access Control List """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}' - dict_path={'product_name': product_name, 'session_access_control_list_id': session_access_control_list_id} + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}" + dict_path = { + "product_name": product_name, + "session_access_control_list_id": session_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id(self,product_name="",session_access_control_list_id="",body=({})): - """ - Operation: Update some fields of a Session Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: session_access_control_list_id, Description: Numeric ID of the Session Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Session Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number (0-255). Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer - "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer - "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer - "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer - "action":"", #Action. Object Type: string - "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string - "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer - "network_name":"", #Name of Network in FQDN format. Object Type: string - "dual_nat_pool":"", #Dual NAT Pool. Object Type: string - "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer - "src_nat_pool":"", #Source NAT Pool. Object Type: string - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "mirror":"", #Mirror. Object Type: string - "position":0, #Position (1-2000). Object Type: integer - "queue_priority":"", #Queue Priority. Object Type: string - "time_range":"", #Time Range. Object Type: string - "tos":0, #TOS (0-63). Object Type: integer -}], #Rules of the Session Access Control List. Object Type: array + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id( + self, product_name="", session_access_control_list_id="", body=({}) + ): + """ + Operation: Update some fields of a Session Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: session_access_control_list_id, Description: Numeric ID of the Session Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Session Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number (0-255). Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer + "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer + "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer + "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer + "action":"", #Action. Object Type: string + "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string + "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer + "network_name":"", #Name of Network in FQDN format. Object Type: string + "dual_nat_pool":"", #Dual NAT Pool. Object Type: string + "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer + "src_nat_pool":"", #Source NAT Pool. Object Type: string + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "mirror":"", #Mirror. Object Type: string + "position":0, #Position (1-2000). Object Type: integer + "queue_priority":"", #Queue Priority. Object Type: string + "time_range":"", #Time Range. Object Type: string + "tos":0, #TOS (0-63). Object Type: integer + }], #Rules of the Session Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}" + dict_path = { + "product_name": product_name, + "session_access_control_list_id": session_access_control_list_id, } - """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}' - dict_path={'product_name': product_name, 'session_access_control_list_id': session_access_control_list_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id(self,product_name="",session_access_control_list_id="",body=({})): - """ - Operation: Replace a Session Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: session_access_control_list_id, Description: Numeric ID of the Session Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Session Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number (0-255). Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer - "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer - "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer - "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer - "action":"", #Action. Object Type: string - "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string - "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer - "network_name":"", #Name of Network in FQDN format. Object Type: string - "dual_nat_pool":"", #Dual NAT Pool. Object Type: string - "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer - "src_nat_pool":"", #Source NAT Pool. Object Type: string - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "mirror":"", #Mirror. Object Type: string - "position":0, #Position (1-2000). Object Type: integer - "queue_priority":"", #Queue Priority. Object Type: string - "time_range":"", #Time Range. Object Type: string - "tos":0, #TOS (0-63). Object Type: integer -}], #Rules of the Session Access Control List. Object Type: array + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id( + self, product_name="", session_access_control_list_id="", body=({}) + ): + """ + Operation: Replace a Session Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: session_access_control_list_id, Description: Numeric ID of the Session Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Session Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number (0-255). Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer + "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer + "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer + "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer + "action":"", #Action. Object Type: string + "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string + "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer + "network_name":"", #Name of Network in FQDN format. Object Type: string + "dual_nat_pool":"", #Dual NAT Pool. Object Type: string + "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer + "src_nat_pool":"", #Source NAT Pool. Object Type: string + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "mirror":"", #Mirror. Object Type: string + "position":0, #Position (1-2000). Object Type: integer + "queue_priority":"", #Queue Priority. Object Type: string + "time_range":"", #Time Range. Object Type: string + "tos":0, #TOS (0-63). Object Type: integer + }], #Rules of the Session Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}" + dict_path = { + "product_name": product_name, + "session_access_control_list_id": session_access_control_list_id, } - """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}' - dict_path={'product_name': product_name, 'session_access_control_list_id': session_access_control_list_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id(self,product_name="",session_access_control_list_id=""): + def delete_enforcement_profile_dur_session_access_control_list_by_product_name_session_access_control_list_id( + self, product_name="", session_access_control_list_id="" + ): """ Operation: Delete a Session Access Control List HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: session_access_control_list_id, Description: Numeric ID of the Session Access Control List """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}' - dict_path={'product_name': product_name, 'session_access_control_list_id': session_access_control_list_id} + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/{session_access_control_list_id}" + dict_path = { + "product_name": product_name, + "session_access_control_list_id": session_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_session_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_session_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Session Access Control List by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Session Access Control List """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_session_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Update some fields of a Session Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Session Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Session Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number (0-255). Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer - "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer - "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer - "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer - "action":"", #Action. Object Type: string - "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string - "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer - "network_name":"", #Name of Network in FQDN format. Object Type: string - "dual_nat_pool":"", #Dual NAT Pool. Object Type: string - "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer - "src_nat_pool":"", #Source NAT Pool. Object Type: string - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "mirror":"", #Mirror. Object Type: string - "position":0, #Position (1-2000). Object Type: integer - "queue_priority":"", #Queue Priority. Object Type: string - "time_range":"", #Time Range. Object Type: string - "tos":0, #TOS (0-63). Object Type: integer -}], #Rules of the Session Access Control List. Object Type: array - } - """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_session_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Update some fields of a Session Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Session Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Session Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number (0-255). Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer + "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer + "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer + "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer + "action":"", #Action. Object Type: string + "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string + "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer + "network_name":"", #Name of Network in FQDN format. Object Type: string + "dual_nat_pool":"", #Dual NAT Pool. Object Type: string + "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer + "src_nat_pool":"", #Source NAT Pool. Object Type: string + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "mirror":"", #Mirror. Object Type: string + "position":0, #Position (1-2000). Object Type: integer + "queue_priority":"", #Queue Priority. Object Type: string + "time_range":"", #Time Range. Object Type: string + "tos":0, #TOS (0-63). Object Type: integer + }], #Rules of the Session Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_session_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Replace a Session Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Session Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Session Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number (0-255). Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer - "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer - "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer - "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer - "action":"", #Action. Object Type: string - "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string - "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer - "network_name":"", #Name of Network in FQDN format. Object Type: string - "dual_nat_pool":"", #Dual NAT Pool. Object Type: string - "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer - "src_nat_pool":"", #Source NAT Pool. Object Type: string - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "mirror":"", #Mirror. Object Type: string - "position":0, #Position (1-2000). Object Type: integer - "queue_priority":"", #Queue Priority. Object Type: string - "time_range":"", #Time Range. Object Type: string - "tos":0, #TOS (0-63). Object Type: integer -}], #Rules of the Session Access Control List. Object Type: array - } - """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_session_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Replace a Session Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Session Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Session Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number (0-255). Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port (0-65535). Object Type: integer + "tcp_max_port":0, #TCP Max Port (0-65535). Object Type: integer + "udp_min_port":0, #UDP Min Port (0-65535). Object Type: integer + "udp_max_port":0, #UDP Max Port (0-65535). Object Type: integer + "action":"", #Action. Object Type: string + "dst_nat_ip_address":"", #Destination NAT IP Address. Object Type: string + "dst_nat_port":0, #Destination NAT Port (0-65535). Object Type: integer + "network_name":"", #Name of Network in FQDN format. Object Type: string + "dual_nat_pool":"", #Dual NAT Pool. Object Type: string + "tunnel_id":0, #Tunnel ID (1-50). Object Type: integer + "src_nat_pool":"", #Source NAT Pool. Object Type: string + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "dot1p_priority":0, #802.1p Priority (0-7). Object Type: integer + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "mirror":"", #Mirror. Object Type: string + "position":0, #Position (1-2000). Object Type: integer + "queue_priority":"", #Queue Priority. Object Type: string + "time_range":"", #Time Range. Object Type: string + "tos":0, #TOS (0-63). Object Type: integer + }], #Rules of the Session Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_session_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_session_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Session Access Control List by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Session Access Control List """ - url_path='/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/session-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - # API Service: Manage Stateless Access Control List - def get_enforcement_profile_dur_stateless_access_control_list_by_product_name(self,product_name=""): + # API Service: Manage Stateless Access Control List + def get_enforcement_profile_dur_stateless_access_control_list_by_product_name( + self, product_name="" + ): """ Operation: GET a list of Stateless Access Control Lists HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def new_enforcement_profile_dur_stateless_access_control_list_by_product_name(self,product_name="",body=({})): - """ - Operation: Add a Stateless Access Control List - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Stateless Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number. Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port. Object Type: integer - "tcp_max_port":0, #TCP Max Port. Object Type: integer - "udp_min_port":0, #UDP Min Port. Object Type: integer - "udp_max_port":0, #UDP Max Port. Object Type: integer - "action":"", #Action. Object Type: string - "redirect_type":"", #Redirect Type. Object Type: string - "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string - "tunnel_id":0, #Tunnel ID. Object Type: integer - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "position":0, #Position. Object Type: integer - "policer_profile":"", #Policer Profile. Object Type: string - "qos_profile":"", #QoS Profile. Object Type: string - "time_range":"", #Time Range. Object Type: string -}], #Rules of the Stateless Access Control List. Object Type: array - } - """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}' - dict_path={'product_name': product_name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = ( + "/enforcement-profile-dur/stateless-access-control-list/{product_name}" + ) + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def new_enforcement_profile_dur_stateless_access_control_list_by_product_name( + self, product_name="", body=({}) + ): + """ + Operation: Add a Stateless Access Control List + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Stateless Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number. Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port. Object Type: integer + "tcp_max_port":0, #TCP Max Port. Object Type: integer + "udp_min_port":0, #UDP Min Port. Object Type: integer + "udp_max_port":0, #UDP Max Port. Object Type: integer + "action":"", #Action. Object Type: string + "redirect_type":"", #Redirect Type. Object Type: string + "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string + "tunnel_id":0, #Tunnel ID. Object Type: integer + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "position":0, #Position. Object Type: integer + "policer_profile":"", #Policer Profile. Object Type: string + "qos_profile":"", #QoS Profile. Object Type: string + "time_range":"", #Time Range. Object Type: string + }], #Rules of the Stateless Access Control List. Object Type: array + + } + """ + url_path = ( + "/enforcement-profile-dur/stateless-access-control-list/{product_name}" + ) + dict_path = {"product_name": product_name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id(self,product_name="",stateless_access_control_list_id=""): + def get_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id( + self, product_name="", stateless_access_control_list_id="" + ): """ Operation: Get a Stateless Access Control List HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: stateless_access_control_list_id, Description: Numeric ID of the Stateless Access Control List """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}' - dict_path={'product_name': product_name, 'stateless_access_control_list_id': stateless_access_control_list_id} + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}" + dict_path = { + "product_name": product_name, + "stateless_access_control_list_id": stateless_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id(self,product_name="",stateless_access_control_list_id="",body=({})): - """ - Operation: Update some fields of a Stateless Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: stateless_access_control_list_id, Description: Numeric ID of the Stateless Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Stateless Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number. Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port. Object Type: integer - "tcp_max_port":0, #TCP Max Port. Object Type: integer - "udp_min_port":0, #UDP Min Port. Object Type: integer - "udp_max_port":0, #UDP Max Port. Object Type: integer - "action":"", #Action. Object Type: string - "redirect_type":"", #Redirect Type. Object Type: string - "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string - "tunnel_id":0, #Tunnel ID. Object Type: integer - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "position":0, #Position. Object Type: integer - "policer_profile":"", #Policer Profile. Object Type: string - "qos_profile":"", #QoS Profile. Object Type: string - "time_range":"", #Time Range. Object Type: string -}], #Rules of the Stateless Access Control List. Object Type: array + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id( + self, product_name="", stateless_access_control_list_id="", body=({}) + ): + """ + Operation: Update some fields of a Stateless Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: stateless_access_control_list_id, Description: Numeric ID of the Stateless Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Stateless Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number. Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port. Object Type: integer + "tcp_max_port":0, #TCP Max Port. Object Type: integer + "udp_min_port":0, #UDP Min Port. Object Type: integer + "udp_max_port":0, #UDP Max Port. Object Type: integer + "action":"", #Action. Object Type: string + "redirect_type":"", #Redirect Type. Object Type: string + "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string + "tunnel_id":0, #Tunnel ID. Object Type: integer + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "position":0, #Position. Object Type: integer + "policer_profile":"", #Policer Profile. Object Type: string + "qos_profile":"", #QoS Profile. Object Type: string + "time_range":"", #Time Range. Object Type: string + }], #Rules of the Stateless Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}" + dict_path = { + "product_name": product_name, + "stateless_access_control_list_id": stateless_access_control_list_id, } - """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}' - dict_path={'product_name': product_name, 'stateless_access_control_list_id': stateless_access_control_list_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id(self,product_name="",stateless_access_control_list_id="",body=({})): - """ - Operation: Replace a Stateless Access Control List - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: stateless_access_control_list_id, Description: Numeric ID of the Stateless Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Stateless Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number. Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port. Object Type: integer - "tcp_max_port":0, #TCP Max Port. Object Type: integer - "udp_min_port":0, #UDP Min Port. Object Type: integer - "udp_max_port":0, #UDP Max Port. Object Type: integer - "action":"", #Action. Object Type: string - "redirect_type":"", #Redirect Type. Object Type: string - "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string - "tunnel_id":0, #Tunnel ID. Object Type: integer - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "position":0, #Position. Object Type: integer - "policer_profile":"", #Policer Profile. Object Type: string - "qos_profile":"", #QoS Profile. Object Type: string - "time_range":"", #Time Range. Object Type: string -}], #Rules of the Stateless Access Control List. Object Type: array + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id( + self, product_name="", stateless_access_control_list_id="", body=({}) + ): + """ + Operation: Replace a Stateless Access Control List + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: stateless_access_control_list_id, Description: Numeric ID of the Stateless Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Stateless Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number. Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port. Object Type: integer + "tcp_max_port":0, #TCP Max Port. Object Type: integer + "udp_min_port":0, #UDP Min Port. Object Type: integer + "udp_max_port":0, #UDP Max Port. Object Type: integer + "action":"", #Action. Object Type: string + "redirect_type":"", #Redirect Type. Object Type: string + "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string + "tunnel_id":0, #Tunnel ID. Object Type: integer + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "position":0, #Position. Object Type: integer + "policer_profile":"", #Policer Profile. Object Type: string + "qos_profile":"", #QoS Profile. Object Type: string + "time_range":"", #Time Range. Object Type: string + }], #Rules of the Stateless Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}" + dict_path = { + "product_name": product_name, + "stateless_access_control_list_id": stateless_access_control_list_id, } - """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}' - dict_path={'product_name': product_name, 'stateless_access_control_list_id': stateless_access_control_list_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id(self,product_name="",stateless_access_control_list_id=""): + def delete_enforcement_profile_dur_stateless_access_control_list_by_product_name_stateless_access_control_list_id( + self, product_name="", stateless_access_control_list_id="" + ): """ Operation: Delete a Stateless Access Control List HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: stateless_access_control_list_id, Description: Numeric ID of the Stateless Access Control List """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}' - dict_path={'product_name': product_name, 'stateless_access_control_list_id': stateless_access_control_list_id} + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/{stateless_access_control_list_id}" + dict_path = { + "product_name": product_name, + "stateless_access_control_list_id": stateless_access_control_list_id, + } for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Stateless Access Control List by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Stateless Access Control List """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) - - def update_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Update some fields of a Stateless Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Stateless Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Stateless Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number. Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port. Object Type: integer - "tcp_max_port":0, #TCP Max Port. Object Type: integer - "udp_min_port":0, #UDP Min Port. Object Type: integer - "udp_max_port":0, #UDP Max Port. Object Type: integer - "action":"", #Action. Object Type: string - "redirect_type":"", #Redirect Type. Object Type: string - "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string - "tunnel_id":0, #Tunnel ID. Object Type: integer - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "position":0, #Position. Object Type: integer - "policer_profile":"", #Policer Profile. Object Type: string - "qos_profile":"", #QoS Profile. Object Type: string - "time_range":"", #Time Range. Object Type: string -}], #Rules of the Stateless Access Control List. Object Type: array - } - """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") + + def update_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Update some fields of a Stateless Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Stateless Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Stateless Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number. Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port. Object Type: integer + "tcp_max_port":0, #TCP Max Port. Object Type: integer + "udp_min_port":0, #UDP Min Port. Object Type: integer + "udp_max_port":0, #UDP Max Port. Object Type: integer + "action":"", #Action. Object Type: string + "redirect_type":"", #Redirect Type. Object Type: string + "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string + "tunnel_id":0, #Tunnel ID. Object Type: integer + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "position":0, #Position. Object Type: integer + "policer_profile":"", #Policer Profile. Object Type: string + "qos_profile":"", #QoS Profile. Object Type: string + "time_range":"", #Time Range. Object Type: string + }], #Rules of the Stateless Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body - ) - - def replace_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name(self,product_name="",name="",body=({})): - """ - Operation: Replace a Stateless Access Control List by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Stateless Access Control List - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Stateless Access Control List. Object Type: string - "rules" : [{ - "src_traffic_match":"", #Source Traffic Match. Object Type: string - "src_alias":"", #Source Alias. Object Type: string - "src_ip_address":"", #Source IP Address. Object Type: string - "src_netmask":"", #Source Net Mask. Object Type: string - "dst_traffic_match":"", #Destination Traffic Match. Object Type: string - "dst_alias":"", #Destination Alias. Object Type: string - "dst_ip_address":"", #Destination IP Address. Object Type: string - "dst_netmask":"", #Destination Net Mask. Object Type: string - "service_type":"", #Service Type. Object Type: string - "protocol_number":0, #Protocol Number. Object Type: integer - "service":"", #Service. Object Type: string - "tcp_min_port":0, #TCP Min Port. Object Type: integer - "tcp_max_port":0, #TCP Max Port. Object Type: integer - "udp_min_port":0, #UDP Min Port. Object Type: integer - "udp_max_port":0, #UDP Max Port. Object Type: integer - "action":"", #Action. Object Type: string - "redirect_type":"", #Redirect Type. Object Type: string - "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string - "tunnel_id":0, #Tunnel ID. Object Type: integer - "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string - "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string - "position":0, #Position. Object Type: integer - "policer_profile":"", #Policer Profile. Object Type: string - "qos_profile":"", #QoS Profile. Object Type: string - "time_range":"", #Time Range. Object Type: string -}], #Rules of the Stateless Access Control List. Object Type: array - } - """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + self, url=url_path, method="patch", query=body + ) + + def replace_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): + """ + Operation: Replace a Stateless Access Control List by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Stateless Access Control List + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Stateless Access Control List. Object Type: string + "rules" : [{ + "src_traffic_match":"", #Source Traffic Match. Object Type: string + "src_alias":"", #Source Alias. Object Type: string + "src_ip_address":"", #Source IP Address. Object Type: string + "src_netmask":"", #Source Net Mask. Object Type: string + "dst_traffic_match":"", #Destination Traffic Match. Object Type: string + "dst_alias":"", #Destination Alias. Object Type: string + "dst_ip_address":"", #Destination IP Address. Object Type: string + "dst_netmask":"", #Destination Net Mask. Object Type: string + "service_type":"", #Service Type. Object Type: string + "protocol_number":0, #Protocol Number. Object Type: integer + "service":"", #Service. Object Type: string + "tcp_min_port":0, #TCP Min Port. Object Type: integer + "tcp_max_port":0, #TCP Max Port. Object Type: integer + "udp_min_port":0, #UDP Min Port. Object Type: integer + "udp_max_port":0, #UDP Max Port. Object Type: integer + "action":"", #Action. Object Type: string + "redirect_type":"", #Redirect Type. Object Type: string + "ipsec_map_based_redirect":"", #Redirect based on IPsec Map. Object Type: string + "tunnel_id":0, #Tunnel ID. Object Type: integer + "deny_list_user_if_acl_applied":"", #Deny List User if ACL gets applied. Object Type: string + "log_if_acl_applied":"", #Log if ACL gets applied. Object Type: string + "position":0, #Position. Object Type: integer + "policer_profile":"", #Policer Profile. Object Type: string + "qos_profile":"", #QoS Profile. Object Type: string + "time_range":"", #Time Range. Object Type: string + }], #Rules of the Stateless Access Control List. Object Type: array + + } + """ + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_stateless_access_control_list_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Stateless Access Control List by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Stateless Access Control List """ - url_path='/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/stateless-access-control-list/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - # API Service: Manage Time Range - def get_enforcement_profile_dur_time_range_by_product_name(self,product_name=""): + # API Service: Manage Time Range + def get_enforcement_profile_dur_time_range_by_product_name(self, product_name=""): """ Operation: GET a list of Time Ranges HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/time-range/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/time-range/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_time_range_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_time_range_by_product_name( + self, product_name="", body=({}) + ): """ - Operation: Add a Time Range - HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Required Body Parameters:['name', 'rules'] - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Time Range. Object Type: string - "type" : "", #Type of the Time Range. Object Type: string - "rules" : [{ - "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string - "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string - "start_time":"", #Start time. Object Type: string - "end_time":"", #End Time. Object Type: string -}], #Rules of the Time Range. Object Type: array - } + Operation: Add a Time Range + HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Required Body Parameters:['name', 'rules'] + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Time Range. Object Type: string + "type" : "", #Type of the Time Range. Object Type: string + "rules" : [{ + "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string + "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string + "start_time":"", #Start time. Object Type: string + "end_time":"", #End Time. Object Type: string + }], #Rules of the Time Range. Object Type: array + + } """ - url_path='/enforcement-profile-dur/time-range/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/time-range/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_time_range_by_product_name_time_range_id(self,product_name="",time_range_id=""): + def get_enforcement_profile_dur_time_range_by_product_name_time_range_id( + self, product_name="", time_range_id="" + ): """ Operation: Get a Time Range HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: time_range_id, Description: Numeric ID of the Time Range """ - url_path='/enforcement-profile-dur/time-range/{product_name}/{time_range_id}' - dict_path={'product_name': product_name, 'time_range_id': time_range_id} + url_path = "/enforcement-profile-dur/time-range/{product_name}/{time_range_id}" + dict_path = {"product_name": product_name, "time_range_id": time_range_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_time_range_by_product_name_time_range_id(self,product_name="",time_range_id="",body=({})): + def update_enforcement_profile_dur_time_range_by_product_name_time_range_id( + self, product_name="", time_range_id="", body=({}) + ): """ - Operation: Update some fields of a Time Range - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: time_range_id, Description: Numeric ID of the Time Range - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Time Range. Object Type: string - "type" : "", #Type of the Time Range. Object Type: string - "rules" : [{ - "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string - "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string - "start_time":"", #Start time. Object Type: string - "end_time":"", #End Time. Object Type: string -}], #Rules of the Time Range. Object Type: array - } + Operation: Update some fields of a Time Range + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: time_range_id, Description: Numeric ID of the Time Range + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Time Range. Object Type: string + "type" : "", #Type of the Time Range. Object Type: string + "rules" : [{ + "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string + "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string + "start_time":"", #Start time. Object Type: string + "end_time":"", #End Time. Object Type: string + }], #Rules of the Time Range. Object Type: array + + } """ - url_path='/enforcement-profile-dur/time-range/{product_name}/{time_range_id}' - dict_path={'product_name': product_name, 'time_range_id': time_range_id} + url_path = "/enforcement-profile-dur/time-range/{product_name}/{time_range_id}" + dict_path = {"product_name": product_name, "time_range_id": time_range_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_time_range_by_product_name_time_range_id(self,product_name="",time_range_id="",body=({})): + def replace_enforcement_profile_dur_time_range_by_product_name_time_range_id( + self, product_name="", time_range_id="", body=({}) + ): """ - Operation: Replace a Time Range - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: time_range_id, Description: Numeric ID of the Time Range - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Time Range. Object Type: string - "type" : "", #Type of the Time Range. Object Type: string - "rules" : [{ - "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string - "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string - "start_time":"", #Start time. Object Type: string - "end_time":"", #End Time. Object Type: string -}], #Rules of the Time Range. Object Type: array - } + Operation: Replace a Time Range + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: time_range_id, Description: Numeric ID of the Time Range + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Time Range. Object Type: string + "type" : "", #Type of the Time Range. Object Type: string + "rules" : [{ + "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string + "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string + "start_time":"", #Start time. Object Type: string + "end_time":"", #End Time. Object Type: string + }], #Rules of the Time Range. Object Type: array + + } """ - url_path='/enforcement-profile-dur/time-range/{product_name}/{time_range_id}' - dict_path={'product_name': product_name, 'time_range_id': time_range_id} + url_path = "/enforcement-profile-dur/time-range/{product_name}/{time_range_id}" + dict_path = {"product_name": product_name, "time_range_id": time_range_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_time_range_by_product_name_time_range_id(self,product_name="",time_range_id=""): + def delete_enforcement_profile_dur_time_range_by_product_name_time_range_id( + self, product_name="", time_range_id="" + ): """ Operation: Delete a Time Range HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: time_range_id, Description: Numeric ID of the Time Range """ - url_path='/enforcement-profile-dur/time-range/{product_name}/{time_range_id}' - dict_path={'product_name': product_name, 'time_range_id': time_range_id} + url_path = "/enforcement-profile-dur/time-range/{product_name}/{time_range_id}" + dict_path = {"product_name": product_name, "time_range_id": time_range_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_time_range_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_time_range_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a Time Range by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Time Range """ - url_path='/enforcement-profile-dur/time-range/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/time-range/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_time_range_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_time_range_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ - Operation: Update some fields of a Time Range by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Time Range - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Time Range. Object Type: string - "type" : "", #Type of the Time Range. Object Type: string - "rules" : [{ - "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string - "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string - "start_time":"", #Start time. Object Type: string - "end_time":"", #End Time. Object Type: string -}], #Rules of the Time Range. Object Type: array - } + Operation: Update some fields of a Time Range by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Time Range + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Time Range. Object Type: string + "type" : "", #Type of the Time Range. Object Type: string + "rules" : [{ + "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string + "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string + "start_time":"", #Start time. Object Type: string + "end_time":"", #End Time. Object Type: string + }], #Rules of the Time Range. Object Type: array + + } """ - url_path='/enforcement-profile-dur/time-range/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/time-range/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_time_range_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_time_range_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ - Operation: Replace a Time Range by name - HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity - Parameter Type: path, Name: product_name, Description: Product Name - Parameter Type: path, Name: name, Description: Name of the Time Range - Required Body Parameters: None listed - Parameter Type: body, Name: body - Body example with descriptions and object types below (type(dict): - body={ - "name" : "", #Name of the Time Range. Object Type: string - "type" : "", #Type of the Time Range. Object Type: string - "rules" : [{ - "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string - "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string - "start_time":"", #Start time. Object Type: string - "end_time":"", #End Time. Object Type: string -}], #Rules of the Time Range. Object Type: array - } + Operation: Replace a Time Range by name + HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity + Parameter Type: path, Name: product_name, Description: Product Name + Parameter Type: path, Name: name, Description: Name of the Time Range + Required Body Parameters: None listed + Parameter Type: body, Name: body + Body example with descriptions and object types below (type(dict): + + body={ + "name" : "", #Name of the Time Range. Object Type: string + "type" : "", #Type of the Time Range. Object Type: string + "rules" : [{ + "start_day_or_date":"", #Start day for Periodic Time Range or Start date for Absolute Time Range. Object Type: string + "end_day_or_date":"", #End Day for Periodic Time Range or End date for Absolute Time Range. Object Type: string + "start_time":"", #Start time. Object Type: string + "end_time":"", #End Time. Object Type: string + }], #Rules of the Time Range. Object Type: array + + } """ - url_path='/enforcement-profile-dur/time-range/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/time-range/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_time_range_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_time_range_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a Time Range by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the Time Range """ - url_path='/enforcement-profile-dur/time-range/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/time-range/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") # API Service: Manage VoIP Profile - def get_enforcement_profile_dur_voip_profile_by_product_name(self,product_name=""): + def get_enforcement_profile_dur_voip_profile_by_product_name(self, product_name=""): """ Operation: GET a list of VoIP Profiles HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/voip-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def new_enforcement_profile_dur_voip_profile_by_product_name(self,product_name="",body=({})): + def new_enforcement_profile_dur_voip_profile_by_product_name( + self, product_name="", body=({}) + ): """ Operation: Add a VoIP Profile HTTP Response Codes: 201 Created, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -3599,38 +4019,44 @@ def new_enforcement_profile_dur_voip_profile_by_product_name(self,product_name=" Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the VoIP Profile. Object Type: string "voip_vlan" : 0, #VoIP VLAN of the VoIP Profile (1-4094). Object Type: integer "dscp" : 0, #DSCP of the VoIP Profile (0-63). Object Type: integer "dot1p" : "", #802.1p of the VoIP Profile (0-7). Object Type: string + } """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}' - dict_path={'product_name': product_name} + url_path = "/enforcement-profile-dur/voip-profile/{product_name}" + dict_path = {"product_name": product_name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='post',query=body + self, url=url_path, method="post", query=body ) - def get_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id(self,product_name="",voip_profile_id=""): + def get_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id( + self, product_name="", voip_profile_id="" + ): """ Operation: Get a VoIP Profile HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: voip_profile_id, Description: Numeric ID of the VoIP Profile """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}' - dict_path={'product_name': product_name, 'voip_profile_id': voip_profile_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' + url_path = ( + "/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}" ) + dict_path = {"product_name": product_name, "voip_profile_id": voip_profile_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id(self,product_name="",voip_profile_id="",body=({})): + def update_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id( + self, product_name="", voip_profile_id="", body=({}) + ): """ Operation: Update some fields of a VoIP Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -3639,23 +4065,29 @@ def update_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the VoIP Profile. Object Type: string "voip_vlan" : 0, #VoIP VLAN of the VoIP Profile (1-4094). Object Type: integer "dscp" : 0, #DSCP of the VoIP Profile (0-63). Object Type: integer "dot1p" : "", #802.1p of the VoIP Profile (0-7). Object Type: string + } """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}' - dict_path={'product_name': product_name, 'voip_profile_id': voip_profile_id} + url_path = ( + "/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}" + ) + dict_path = {"product_name": product_name, "voip_profile_id": voip_profile_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id(self,product_name="",voip_profile_id="",body=({})): + def replace_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id( + self, product_name="", voip_profile_id="", body=({}) + ): """ Operation: Replace a VoIP Profile HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -3664,53 +4096,61 @@ def replace_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the VoIP Profile. Object Type: string "voip_vlan" : 0, #VoIP VLAN of the VoIP Profile (1-4094). Object Type: integer "dscp" : 0, #DSCP of the VoIP Profile (0-63). Object Type: integer "dot1p" : "", #802.1p of the VoIP Profile (0-7). Object Type: string + } """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}' - dict_path={'product_name': product_name, 'voip_profile_id': voip_profile_id} + url_path = ( + "/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}" + ) + dict_path = {"product_name": product_name, "voip_profile_id": voip_profile_id} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id(self,product_name="",voip_profile_id=""): + def delete_enforcement_profile_dur_voip_profile_by_product_name_voip_profile_id( + self, product_name="", voip_profile_id="" + ): """ Operation: Delete a VoIP Profile HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: voip_profile_id, Description: Numeric ID of the VoIP Profile """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}' - dict_path={'product_name': product_name, 'voip_profile_id': voip_profile_id} - for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' + url_path = ( + "/enforcement-profile-dur/voip-profile/{product_name}/{voip_profile_id}" ) + dict_path = {"product_name": product_name, "voip_profile_id": voip_profile_id} + for item in dict_path: + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") - def get_enforcement_profile_dur_voip_profile_by_product_name_name_name(self,product_name="",name=""): + def get_enforcement_profile_dur_voip_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Get a VoIP Profile by name HTTP Response Codes: 200 OK, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the VoIP Profile """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/voip-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='get' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="get") - def update_enforcement_profile_dur_voip_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def update_enforcement_profile_dur_voip_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Update some fields of a VoIP Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -3719,23 +4159,27 @@ def update_enforcement_profile_dur_voip_profile_by_product_name_name_name(self,p Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the VoIP Profile. Object Type: string "voip_vlan" : 0, #VoIP VLAN of the VoIP Profile (1-4094). Object Type: integer "dscp" : 0, #DSCP of the VoIP Profile (0-63). Object Type: integer "dot1p" : "", #802.1p of the VoIP Profile (0-7). Object Type: string + } """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/voip-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='patch',query=body + self, url=url_path, method="patch", query=body ) - def replace_enforcement_profile_dur_voip_profile_by_product_name_name_name(self,product_name="",name="",body=({})): + def replace_enforcement_profile_dur_voip_profile_by_product_name_name_name( + self, product_name="", name="", body=({}) + ): """ Operation: Replace a VoIP Profile by name HTTP Response Codes: 200 OK, 204 No Content, 304 Not Modified, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type, 422 Unprocessable Entity @@ -3744,33 +4188,35 @@ def replace_enforcement_profile_dur_voip_profile_by_product_name_name_name(self, Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the VoIP Profile. Object Type: string "voip_vlan" : 0, #VoIP VLAN of the VoIP Profile (1-4094). Object Type: integer "dscp" : 0, #DSCP of the VoIP Profile (0-63). Object Type: integer "dot1p" : "", #802.1p of the VoIP Profile (0-7). Object Type: string + } """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/voip-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) + url_path = url_path.replace("{" + item + "}", dict_path[item]) body = _remove_empty_keys(keys=body) return ClearPassAPILogin._send_request( - self,url=url_path,method='put',query=body + self, url=url_path, method="put", query=body ) - def delete_enforcement_profile_dur_voip_profile_by_product_name_name_name(self,product_name="",name=""): + def delete_enforcement_profile_dur_voip_profile_by_product_name_name_name( + self, product_name="", name="" + ): """ Operation: Delete a VoIP Profile by name HTTP Response Codes: 204 No Content, 401 Unauthorized, 403 Forbidden, 404 Not Found, 406 Not Acceptable, 415 Unsupported Media Type Parameter Type: path, Name: product_name, Description: Product Name Parameter Type: path, Name: name, Description: Name of the VoIP Profile """ - url_path='/enforcement-profile-dur/voip-profile/{product_name}/name/{name}' - dict_path={'product_name': product_name, 'name': name} + url_path = "/enforcement-profile-dur/voip-profile/{product_name}/name/{name}" + dict_path = {"product_name": product_name, "name": name} for item in dict_path: - url_path = url_path.replace('{'+item+'}',dict_path[item]) - return ClearPassAPILogin._send_request( - self,url=url_path,method='delete' - ) + url_path = url_path.replace("{" + item + "}", dict_path[item]) + return ClearPassAPILogin._send_request(self, url=url_path, method="delete") diff --git a/pyclearpass/api_globalserverconfiguration.py b/pyclearpass/api_globalserverconfiguration.py index b498dbf..1674506 100644 --- a/pyclearpass/api_globalserverconfiguration.py +++ b/pyclearpass/api_globalserverconfiguration.py @@ -40,6 +40,7 @@ def new_admin_privilege(self, body=({})): Required Body Parameters:['name', 'cppm_privileges'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin privilege. Object Type: string "description" : "", #Description of the admin privilege. Object Type: string @@ -48,6 +49,7 @@ def new_admin_privilege(self, body=({})): "insight_privileges" : {}, #Privilege list in JSON object format(e.g., {"report": "RWD", "dashboard":"RW"}).. Object Type: object "allow_passwords" : False, #If selected, all passwords may be displayed in the response. Object Type: boolean "allow_security_configs" : False, #If selected, Admin user will have access for security configuration. Object Type: boolean + } """ url_path = "/admin-privilege" @@ -78,6 +80,7 @@ def update_admin_privilege_by_admin_privilege_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin privilege. Object Type: string "description" : "", #Description of the admin privilege. Object Type: string @@ -86,6 +89,7 @@ def update_admin_privilege_by_admin_privilege_id( "insight_privileges" : {}, #Privilege list in JSON object format(e.g., {"report": "RWD", "dashboard":"RW"}).. Object Type: object "allow_passwords" : False, #If selected, all passwords may be displayed in the response. Object Type: boolean "allow_security_configs" : False, #If selected, Admin user will have access for security configuration. Object Type: boolean + } """ url_path = "/admin-privilege/{admin_privilege_id}" @@ -107,6 +111,7 @@ def replace_admin_privilege_by_admin_privilege_id( Required Body Parameters:['name', 'cppm_privileges'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin privilege. Object Type: string "description" : "", #Description of the admin privilege. Object Type: string @@ -115,6 +120,7 @@ def replace_admin_privilege_by_admin_privilege_id( "insight_privileges" : {}, #Privilege list in JSON object format(e.g., {"report": "RWD", "dashboard":"RW"}).. Object Type: object "allow_passwords" : False, #If selected, all passwords may be displayed in the response. Object Type: boolean "allow_security_configs" : False, #If selected, Admin user will have access for security configuration. Object Type: boolean + } """ url_path = "/admin-privilege/{admin_privilege_id}" @@ -158,6 +164,7 @@ def update_admin_privilege_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin privilege. Object Type: string "description" : "", #Description of the admin privilege. Object Type: string @@ -166,6 +173,7 @@ def update_admin_privilege_name_by_name(self, name="", body=({})): "insight_privileges" : {}, #Privilege list in JSON object format(e.g., {"report": "RWD", "dashboard":"RW"}).. Object Type: object "allow_passwords" : False, #If selected, all passwords may be displayed in the response. Object Type: boolean "allow_security_configs" : False, #If selected, Admin user will have access for security configuration. Object Type: boolean + } """ url_path = "/admin-privilege/name/{name}" @@ -185,6 +193,7 @@ def replace_admin_privilege_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'cppm_privileges'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin privilege. Object Type: string "description" : "", #Description of the admin privilege. Object Type: string @@ -193,6 +202,7 @@ def replace_admin_privilege_name_by_name(self, name="", body=({})): "insight_privileges" : {}, #Privilege list in JSON object format(e.g., {"report": "RWD", "dashboard":"RW"}).. Object Type: object "allow_passwords" : False, #If selected, all passwords may be displayed in the response. Object Type: boolean "allow_security_configs" : False, #If selected, Admin user will have access for security configuration. Object Type: boolean + } """ url_path = "/admin-privilege/name/{name}" @@ -247,12 +257,14 @@ def new_admin_user(self, body=({})): Required Body Parameters:['name', 'user_id', 'password', 'privilege_level'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin user. Object Type: string "user_id" : "", #Unique user id of the admin user. Object Type: string "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "password" : "", #Password of the admin user. Object Type: string "privilege_level" : "", #Name of the admin privilege. Object Type: string + } """ url_path = "/admin-user" @@ -281,12 +293,14 @@ def update_admin_user_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin user. Object Type: string "user_id" : "", #Unique user id of the admin user. Object Type: string "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "password" : "", #Password of the admin user. Object Type: string "privilege_level" : "", #Name of the admin privilege. Object Type: string + } """ url_path = "/admin-user/{id}" @@ -306,12 +320,14 @@ def replace_admin_user_by_id(self, id="", body=({})): Required Body Parameters:['name', 'user_id', 'password', 'privilege_level'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin user. Object Type: string "user_id" : "", #Unique user id of the admin user. Object Type: string "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "password" : "", #Password of the admin user. Object Type: string "privilege_level" : "", #Name of the admin privilege. Object Type: string + } """ url_path = "/admin-user/{id}" @@ -355,12 +371,14 @@ def update_admin_user_user_id_by_user_id(self, user_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin user. Object Type: string "user_id" : "", #Unique user id of the admin user. Object Type: string "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "password" : "", #Password of the admin user. Object Type: string "privilege_level" : "", #Name of the admin privilege. Object Type: string + } """ url_path = "/admin-user/user-id/{user_id}" @@ -380,12 +398,14 @@ def replace_admin_user_user_id_by_user_id(self, user_id="", body=({})): Required Body Parameters:['name', 'user_id', 'password', 'privilege_level'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the admin user. Object Type: string "user_id" : "", #Unique user id of the admin user. Object Type: string "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "password" : "", #Password of the admin user. Object Type: string "privilege_level" : "", #Name of the admin privilege. Object Type: string + } """ url_path = "/admin-user/user-id/{user_id}" @@ -425,6 +445,7 @@ def replace_admin_user_password_policy(self, body=({})): Required Body Parameters:['password_minimum_length', 'password_complexity'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "password_minimum_length" : 0, #Minimum length of the password. Object Type: integer "password_complexity" : "", #Complexity Level of the password. Object Type: string @@ -436,6 +457,7 @@ def replace_admin_user_password_policy(self, body=({})): "disable_after_failed_attempts" : 0, #Failed attempts count. Object Type: integer "password_remember_history" : 0, #Must be different from this many previous passwords. Object Type: integer "reset_failed_attempts_count" : False, #Reset failed attempts count and enable those users. Object Type: boolean + } """ url_path = "/admin-user/password-policy" @@ -451,6 +473,7 @@ def update_admin_user_password_policy(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "password_minimum_length" : 0, #Minimum length of the password. Object Type: integer "password_complexity" : "", #Complexity Level of the password. Object Type: string @@ -462,6 +485,7 @@ def update_admin_user_password_policy(self, body=({})): "disable_after_failed_attempts" : 0, #Failed attempts count. Object Type: integer "password_remember_history" : 0, #Must be different from this many previous passwords. Object Type: integer "reset_failed_attempts_count" : False, #Reset failed attempts count and enable those users. Object Type: boolean + } """ url_path = "/admin-user/password-policy" @@ -486,8 +510,10 @@ def new_application_license(self, body=({})): Required Body Parameters:['license_key'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "license_key" : "", #License key. Object Type: string + } """ url_path = "/application-license" @@ -516,8 +542,10 @@ def replace_application_license_by_license_id(self, license_id="", body=({})): Required Body Parameters:['license_key'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "license_key" : "", #License key. Object Type: string + } """ url_path = "/application-license/{license_id}" @@ -604,6 +632,7 @@ def new_attribute(self, body=({})): Required Body Parameters:['name', 'entity_name', 'data_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the attribute. Object Type: string "entity_name" : "", #Entity Name of the attribute. Object Type: string @@ -612,6 +641,7 @@ def new_attribute(self, body=({})): "default_value" : "", #Default Value of the attribute. Object Type: string "allow_multiple" : False, #To Allow Multiple values of the attribute for Data Type String. Object Type: boolean "allowed_value" : "", #Allowed Value for Data Type List (e.g., example1,example2,example3). Object Type: string + } """ url_path = "/attribute" @@ -640,6 +670,7 @@ def update_attribute_by_attribute_id(self, attribute_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the attribute. Object Type: string "entity_name" : "", #Entity Name of the attribute. Object Type: string @@ -648,6 +679,7 @@ def update_attribute_by_attribute_id(self, attribute_id="", body=({})): "default_value" : "", #Default Value of the attribute. Object Type: string "allow_multiple" : False, #To Allow Multiple values of the attribute for Data Type String. Object Type: boolean "allowed_value" : "", #Allowed Value for Data Type List (e.g., example1,example2,example3). Object Type: string + } """ url_path = "/attribute/{attribute_id}" @@ -667,6 +699,7 @@ def replace_attribute_by_attribute_id(self, attribute_id="", body=({})): Required Body Parameters:['name', 'entity_name', 'data_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the attribute. Object Type: string "entity_name" : "", #Entity Name of the attribute. Object Type: string @@ -675,6 +708,7 @@ def replace_attribute_by_attribute_id(self, attribute_id="", body=({})): "default_value" : "", #Default Value of the attribute. Object Type: string "allow_multiple" : False, #To Allow Multiple values of the attribute for Data Type String. Object Type: boolean "allowed_value" : "", #Allowed Value for Data Type List (e.g., example1,example2,example3). Object Type: string + } """ url_path = "/attribute/{attribute_id}" @@ -722,6 +756,7 @@ def update_attribute_by_entity_name_name_name( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the attribute. Object Type: string "entity_name" : "", #Entity Name of the attribute. Object Type: string @@ -730,6 +765,7 @@ def update_attribute_by_entity_name_name_name( "default_value" : "", #Default Value of the attribute. Object Type: string "allow_multiple" : False, #To Allow Multiple values of the attribute for Data Type String. Object Type: boolean "allowed_value" : "", #Allowed Value for Data Type List (e.g., example1,example2,example3). Object Type: string + } """ url_path = "/attribute/{entity_name}/name/{name}" @@ -752,6 +788,7 @@ def replace_attribute_by_entity_name_name_name( Required Body Parameters:['name', 'entity_name', 'data_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the attribute. Object Type: string "entity_name" : "", #Entity Name of the attribute. Object Type: string @@ -760,6 +797,7 @@ def replace_attribute_by_entity_name_name_name( "default_value" : "", #Default Value of the attribute. Object Type: string "allow_multiple" : False, #To Allow Multiple values of the attribute for Data Type String. Object Type: boolean "allowed_value" : "", #Allowed Value for Data Type List (e.g., example1,example2,example3). Object Type: string + } """ url_path = "/attribute/{entity_name}/name/{name}" @@ -800,6 +838,7 @@ def new_clearpass_portal(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "title" : "", #Default Landing page Title. Object Type: string "header" : "", #Default Landing page Header. Object Type: string @@ -808,6 +847,7 @@ def new_clearpass_portal(self, body=({})): "app_name" : "", #If specified, User will be redirected to the selected ClearPass application login page. Object Type: string "guest_portal" : "", #If specified, User will be redirected to the selected Guest Web Login/Self-Registration Portal. Object Type: string "url" : "", #Redirect URL constructed based on the Guest Portal name(guest_portal) or Application Login Page(app_name). Object Type: string + } """ url_path = "/clearpass-portal" @@ -824,8 +864,10 @@ def new_cluster_db_sync(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "timeout" : "", #Maximum time in seconds to wait for the database sync operation. Object Type: string + } """ url_path = "/cluster/db-sync" @@ -850,6 +892,7 @@ def replace_cluster_parameters(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "AdminSessionIdleTimeout" : 0, #Admin Session Idle Timeout in minutes. Object Type: integer "AdminUserLoginRemoteTacacsServerIP" : "", #Remote TACACS+ server for Admin logins. Object Type: string @@ -928,6 +971,7 @@ def replace_cluster_parameters(self, body=({})): "UserPrompt" : "", #TACACS+ User Prompt Text. Object Type: string "allowConcurrentLogin" : "", #Enable Concurrent Admin Login. Object Type: string "session_cache_type" : "", #No Desc. Object Type: string + } """ url_path = "/cluster/parameters" @@ -943,6 +987,7 @@ def update_cluster_parameters(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "AdminSessionIdleTimeout" : 0, #Admin Session Idle Timeout in minutes. Object Type: integer "AdminUserLoginRemoteTacacsServerIP" : "", #Remote TACACS+ server for Admin logins. Object Type: string @@ -1021,6 +1066,7 @@ def update_cluster_parameters(self, body=({})): "UserPrompt" : "", #TACACS+ User Prompt Text. Object Type: string "allowConcurrentLogin" : "", #Enable Concurrent Admin Login. Object Type: string "session_cache_type" : "", #No Desc. Object Type: string + } """ url_path = "/cluster/parameters" @@ -1060,6 +1106,7 @@ def new_data_filter(self, body=({})): Required Body Parameters:['name', 'type', 'configuration_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Data Filter. Object Type: string "description" : "", #Description of the Data Filter. Object Type: string @@ -1069,7 +1116,8 @@ def new_data_filter(self, body=({})): "template" : "", #Template name for Data Filter (applicable when type=INSIGHT). Object Type: string "custom_sql" : "", #Custom SQL of the Data Filter. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Data Filter, applicable only for attributes. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsCreate + "rules" : "", #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsCreate + } """ url_path = "/data-filter" @@ -1098,6 +1146,7 @@ def update_data_filter_by_data_filter_id(self, data_filter_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Data Filter. Object Type: string "description" : "", #Description of the Data Filter. Object Type: string @@ -1107,7 +1156,8 @@ def update_data_filter_by_data_filter_id(self, data_filter_id="", body=({})): "template" : "", #Template name for Data Filter (applicable when type=INSIGHT). Object Type: string "custom_sql" : "", #Custom SQL of the Data Filter. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Data Filter, applicable only for attributes. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsUpdate + "rules" : "", #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsUpdate + } """ url_path = "/data-filter/{data_filter_id}" @@ -1127,6 +1177,7 @@ def replace_data_filter_by_data_filter_id(self, data_filter_id="", body=({})): Required Body Parameters:['name', 'type', 'configuration_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Data Filter. Object Type: string "description" : "", #Description of the Data Filter. Object Type: string @@ -1136,7 +1187,8 @@ def replace_data_filter_by_data_filter_id(self, data_filter_id="", body=({})): "template" : "", #Template name for Data Filter (applicable when type=INSIGHT). Object Type: string "custom_sql" : "", #Custom SQL of the Data Filter. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Data Filter, applicable only for attributes. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsReplace + "rules" : "", #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsReplace + } """ url_path = "/data-filter/{data_filter_id}" @@ -1180,6 +1232,7 @@ def update_data_filter_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Data Filter. Object Type: string "description" : "", #Description of the Data Filter. Object Type: string @@ -1189,7 +1242,8 @@ def update_data_filter_name_by_name(self, name="", body=({})): "template" : "", #Template name for Data Filter (applicable when type=INSIGHT). Object Type: string "custom_sql" : "", #Custom SQL of the Data Filter. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Data Filter, applicable only for attributes. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsUpdate + "rules" : "", #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsUpdate + } """ url_path = "/data-filter/name/{name}" @@ -1209,6 +1263,7 @@ def replace_data_filter_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'type', 'configuration_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Data Filter. Object Type: string "description" : "", #Description of the Data Filter. Object Type: string @@ -1218,7 +1273,8 @@ def replace_data_filter_name_by_name(self, name="", body=({})): "template" : "", #Template name for Data Filter (applicable when type=INSIGHT). Object Type: string "custom_sql" : "", #Custom SQL of the Data Filter. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm for rules of Data Filter, applicable only for attributes. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsReplace + "rules" : "", #List of Rules for Data Filter, applicable only for attributes. Object Type: RulesSettingsReplace + } """ url_path = "/data-filter/name/{name}" @@ -1273,6 +1329,7 @@ def new_file_backup_server(self, body=({})): Required Body Parameters:['host_address', 'protocol', 'port', 'username', 'password', 'time_out', 'remote_dir'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of file backup server. Object Type: string "description" : "", #Description of file backup server. Object Type: string @@ -1283,6 +1340,7 @@ def new_file_backup_server(self, body=({})): "time_out" : 0, #Timeout for file backup server . Object Type: integer "remote_dir" : "", #Remote directory for file backup server. Object Type: string "cppm_servers" : "", #ClearPass server UUID List for file backup server. Object Type: array + } """ url_path = "/file-backup-server" @@ -1313,6 +1371,7 @@ def update_file_backup_server_by_file_backup_server_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of file backup server. Object Type: string "description" : "", #Description of file backup server. Object Type: string @@ -1323,6 +1382,7 @@ def update_file_backup_server_by_file_backup_server_id( "time_out" : 0, #Timeout for file backup server . Object Type: integer "remote_dir" : "", #Remote directory for file backup server. Object Type: string "cppm_servers" : "", #ClearPass server UUID List for file backup server. Object Type: array + } """ url_path = "/file-backup-server/{file_backup_server_id}" @@ -1344,6 +1404,7 @@ def replace_file_backup_server_by_file_backup_server_id( Required Body Parameters:['host_address', 'protocol', 'port', 'username', 'password', 'time_out', 'remote_dir'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of file backup server. Object Type: string "description" : "", #Description of file backup server. Object Type: string @@ -1354,6 +1415,7 @@ def replace_file_backup_server_by_file_backup_server_id( "time_out" : 0, #Timeout for file backup server . Object Type: integer "remote_dir" : "", #Remote directory for file backup server. Object Type: string "cppm_servers" : "", #ClearPass server UUID List for file backup server. Object Type: array + } """ url_path = "/file-backup-server/{file_backup_server_id}" @@ -1401,6 +1463,7 @@ def update_file_backup_server_host_address_by_host_address( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of file backup server. Object Type: string "description" : "", #Description of file backup server. Object Type: string @@ -1411,6 +1474,7 @@ def update_file_backup_server_host_address_by_host_address( "time_out" : 0, #Timeout for file backup server . Object Type: integer "remote_dir" : "", #Remote directory for file backup server. Object Type: string "cppm_servers" : "", #ClearPass server UUID List for file backup server. Object Type: array + } """ url_path = "/file-backup-server/host-address/{host_address}" @@ -1432,6 +1496,7 @@ def replace_file_backup_server_host_address_by_host_address( Required Body Parameters:['host_address', 'protocol', 'port', 'username', 'password', 'time_out', 'remote_dir'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of file backup server. Object Type: string "description" : "", #Description of file backup server. Object Type: string @@ -1442,6 +1507,7 @@ def replace_file_backup_server_host_address_by_host_address( "time_out" : 0, #Timeout for file backup server . Object Type: integer "remote_dir" : "", #Remote directory for file backup server. Object Type: string "cppm_servers" : "", #ClearPass server UUID List for file backup server. Object Type: array + } """ url_path = "/file-backup-server/host-address/{host_address}" @@ -1493,6 +1559,7 @@ def replace_local_user_password_policy(self, body=({})): Required Body Parameters:['password_minimum_length', 'password_complexity'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "password_minimum_length" : 0, #Minimum length of the password. Object Type: integer "password_complexity" : "", #Complexity Level of the password. Object Type: string @@ -1509,6 +1576,7 @@ def replace_local_user_password_policy(self, body=({})): "disable_after_unchanged_days" : 0, #Disable after password not changed after this many days. Object Type: integer "disable_after_failed_attempts" : 0, #Failed attempts count. Object Type: integer "reset_failed_attempts_count" : False, #Reset failed attempts count and enable those users. Object Type: boolean + } """ url_path = "/local-user/password-policy" @@ -1524,6 +1592,7 @@ def update_local_user_password_policy(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "password_minimum_length" : 0, #Minimum length of the password. Object Type: integer "password_complexity" : "", #Complexity Level of the password. Object Type: string @@ -1540,6 +1609,7 @@ def update_local_user_password_policy(self, body=({})): "disable_after_unchanged_days" : 0, #Disable after password not changed after this many days. Object Type: integer "disable_after_failed_attempts" : 0, #Failed attempts count. Object Type: integer "reset_failed_attempts_count" : False, #Reset failed attempts count and enable those users. Object Type: boolean + } """ url_path = "/local-user/password-policy" @@ -1564,14 +1634,16 @@ def new_messaging_setup(self, body=({})): Required Body Parameters:['server_name', 'default_from_address'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_name" : "", #SMTP Server Name. Object Type: string "user_name" : "", #Username. Object Type: string "password" : "", #Password. Object Type: string "default_from_address" : "", #Default FROM Address. Object Type: string "connection_security" : "", #Connection Security. Object Type: string - "port" : "" #variable unknown: , #Port Number. Object Type: int - "connection_timeout" : "" #variable unknown: , #Connection Timeout . Object Type: int + "port" : "", #Port Number. Object Type: int + "connection_timeout" : "", #Connection Timeout . Object Type: int + } """ url_path = "/messaging-setup" @@ -1619,6 +1691,7 @@ def new_operator_profile(self, body=({})): Required Body Parameters:['name', 'sponsor_filter'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #Enter a name for this operator profile. Object Type: string @@ -1659,6 +1732,7 @@ def new_operator_profile(self, body=({})): "override_guest_users" : "", #Override the Manage Guest Accounts view. Object Type: string "override_guest_edit_receipt" : "", #Override the Updated Account Details form. Object Type: string "override_mac_edit_receipt" : "", #Override the Updated Device Details form. Object Type: string + } """ url_path = "/operator-profile" @@ -1687,6 +1761,7 @@ def update_operator_profile_by_id(self, id="", body=({})): Required Body Parameters:['name', 'sponsor_filter'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #Enter a name for this operator profile. Object Type: string @@ -1727,6 +1802,7 @@ def update_operator_profile_by_id(self, id="", body=({})): "override_guest_users" : "", #Override the Manage Guest Accounts view. Object Type: string "override_guest_edit_receipt" : "", #Override the Updated Account Details form. Object Type: string "override_mac_edit_receipt" : "", #Override the Updated Device Details form. Object Type: string + } """ url_path = "/operator-profile/{id}" @@ -1746,6 +1822,7 @@ def replace_operator_profile_by_id(self, id="", body=({})): Required Body Parameters:['name', 'sponsor_filter'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #Enter a name for this operator profile. Object Type: string @@ -1786,6 +1863,7 @@ def replace_operator_profile_by_id(self, id="", body=({})): "override_guest_users" : "", #Override the Manage Guest Accounts view. Object Type: string "override_guest_edit_receipt" : "", #Override the Updated Account Details form. Object Type: string "override_mac_edit_receipt" : "", #Override the Updated Device Details form. Object Type: string + } """ url_path = "/operator-profile/{id}" @@ -1829,6 +1907,7 @@ def update_operator_profile_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'sponsor_filter'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #Enter a name for this operator profile. Object Type: string @@ -1869,6 +1948,7 @@ def update_operator_profile_name_by_name(self, name="", body=({})): "override_guest_users" : "", #Override the Manage Guest Accounts view. Object Type: string "override_guest_edit_receipt" : "", #Override the Updated Account Details form. Object Type: string "override_mac_edit_receipt" : "", #Override the Updated Device Details form. Object Type: string + } """ url_path = "/operator-profile/name/{name}" @@ -1888,6 +1968,7 @@ def replace_operator_profile_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'sponsor_filter'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #Enter a name for this operator profile. Object Type: string @@ -1928,6 +2009,7 @@ def replace_operator_profile_name_by_name(self, name="", body=({})): "override_guest_users" : "", #Override the Manage Guest Accounts view. Object Type: string "override_guest_edit_receipt" : "", #Override the Updated Account Details form. Object Type: string "override_mac_edit_receipt" : "", #Override the Updated Device Details form. Object Type: string + } """ url_path = "/operator-profile/name/{name}" @@ -1967,8 +2049,10 @@ def new_server_policy_manager_zones(self, body=({})): Required Body Parameters:['zone_name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "zone_name" : "", #Name of the Policy Manager Zone. Object Type: string + } """ url_path = "/server/policy-manager-zones" @@ -1997,8 +2081,10 @@ def replace_server_policy_manager_zones_by_zone_id(self, zone_id="", body=({})): Required Body Parameters:['zone_name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "zone_name" : "", #Name of the Policy Manager Zone. Object Type: string + } """ url_path = "/server/policy-manager-zones/{zone_id}" @@ -2042,8 +2128,10 @@ def replace_server_policy_manager_zones_name_by_name(self, name="", body=({})): Required Body Parameters:['zone_name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "zone_name" : "", #Name of the Policy Manager Zone. Object Type: string + } """ url_path = "/server/policy-manager-zones/name/{name}" @@ -2098,6 +2186,7 @@ def new_snmp_trap_receiver(self, body=({})): Required Body Parameters:['host_address', 'snmp_version'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #HostName of the SNMP Trap Server. Object Type: string "description" : "", #Description of the SNMP Trap Server. Object Type: string @@ -2111,6 +2200,7 @@ def new_snmp_trap_receiver(self, body=({})): "priv_protocol" : {}, #Privacy Protocol. Object Type: object "auth_protocol" : {}, #Authentication Protocol. Object Type: object "security_level" : {}, #SNMP Version. Object Type: object + } """ url_path = "/snmp-trap-receiver" @@ -2141,6 +2231,7 @@ def update_snmp_trap_receiver_by_snmp_trap_receiver_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #HostName of the SNMP Trap Server. Object Type: string "description" : "", #Description of the SNMP Trap Server. Object Type: string @@ -2154,6 +2245,7 @@ def update_snmp_trap_receiver_by_snmp_trap_receiver_id( "priv_protocol" : {}, #Privacy Protocol. Object Type: object "auth_protocol" : {}, #Authentication Protocol. Object Type: object "security_level" : {}, #SNMP Version. Object Type: object + } """ url_path = "/snmp-trap-receiver/{snmp_trap_receiver_id}" @@ -2175,6 +2267,7 @@ def replace_snmp_trap_receiver_by_snmp_trap_receiver_id( Required Body Parameters:['host_address', 'snmp_version'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #HostName of the SNMP Trap Server. Object Type: string "description" : "", #Description of the SNMP Trap Server. Object Type: string @@ -2188,6 +2281,7 @@ def replace_snmp_trap_receiver_by_snmp_trap_receiver_id( "priv_protocol" : {}, #Privacy Protocol. Object Type: object "auth_protocol" : {}, #Authentication Protocol. Object Type: object "security_level" : {}, #SNMP Version. Object Type: object + } """ url_path = "/snmp-trap-receiver/{snmp_trap_receiver_id}" @@ -2233,6 +2327,7 @@ def update_snmp_trap_receiver_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #HostName of the SNMP Trap Server. Object Type: string "description" : "", #Description of the SNMP Trap Server. Object Type: string @@ -2246,6 +2341,7 @@ def update_snmp_trap_receiver_name_by_name(self, name="", body=({})): "priv_protocol" : {}, #Privacy Protocol. Object Type: object "auth_protocol" : {}, #Authentication Protocol. Object Type: object "security_level" : {}, #SNMP Version. Object Type: object + } """ url_path = "/snmp-trap-receiver/name/{name}" @@ -2265,6 +2361,7 @@ def replace_snmp_trap_receiver_name_by_name(self, name="", body=({})): Required Body Parameters:['host_address', 'snmp_version'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #HostName of the SNMP Trap Server. Object Type: string "description" : "", #Description of the SNMP Trap Server. Object Type: string @@ -2278,6 +2375,7 @@ def replace_snmp_trap_receiver_name_by_name(self, name="", body=({})): "priv_protocol" : {}, #Privacy Protocol. Object Type: object "auth_protocol" : {}, #Authentication Protocol. Object Type: object "security_level" : {}, #SNMP Version. Object Type: object + } """ url_path = "/snmp-trap-receiver/name/{name}" diff --git a/pyclearpass/api_guestactions.py b/pyclearpass/api_guestactions.py index da89e1e..f2f6a77 100644 --- a/pyclearpass/api_guestactions.py +++ b/pyclearpass/api_guestactions.py @@ -46,8 +46,10 @@ def new_guest_by_guest_id_sendreceipt_sms(self, guest_id="", body=({})): Required Body Parameters:['confirm'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "confirm" : False, #Flag to confirm sending guest receipt via SMS. Object Type: boolean + } """ url_path = "/guest/{guest_id}/sendreceipt/sms" @@ -68,8 +70,10 @@ def new_guest_by_guest_id_sendreceipt_smtp(self, guest_id="", body=({})): Required Body Parameters:['confirm'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "confirm" : False, #Flag to confirm sending guest receipt via SMTP. Object Type: boolean + } """ url_path = "/guest/{guest_id}/sendreceipt/smtp" @@ -91,6 +95,7 @@ def new_guest_by_guest_id_sponsor(self, gsr_id="", guest_id="", body=({})): Required Body Parameters:['token', 'register_token'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "token" : "", #Registration token. Object Type: string "register_token" : "", #Registration token. Object Type: string @@ -98,6 +103,7 @@ def new_guest_by_guest_id_sponsor(self, gsr_id="", guest_id="", body=({})): "role_id" : 0, #Override the guest role. Object Type: integer "modify_expire_time" : "", #Override the guest expiration time. Object Type: string "confirm_expire_time" : "", #Timestamp for new expiration time; used if modify_expire_time is "expire_time". Object Type: string + } """ url_path = "/guest/{guest_id}/sponsor" diff --git a/pyclearpass/api_guestconfiguration.py b/pyclearpass/api_guestconfiguration.py index 3a531c2..0884c52 100644 --- a/pyclearpass/api_guestconfiguration.py +++ b/pyclearpass/api_guestconfiguration.py @@ -40,6 +40,7 @@ def new_template_pass(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #No Desc. Object Type: string @@ -68,6 +69,7 @@ def new_template_pass(self, body=({})): "relevant_date_template" : "", #No Desc. Object Type: string "associated_apps" : False, #No Desc. Object Type: boolean "pass_apps" : False, #No Desc. Object Type: array + } """ url_path = "/template/pass" @@ -96,6 +98,7 @@ def update_template_pass_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #No Desc. Object Type: string @@ -124,6 +127,7 @@ def update_template_pass_by_id(self, id="", body=({})): "relevant_date_template" : "", #No Desc. Object Type: string "associated_apps" : False, #No Desc. Object Type: boolean "pass_apps" : False, #No Desc. Object Type: array + } """ url_path = "/template/pass/{id}" @@ -143,6 +147,7 @@ def replace_template_pass_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #No Desc. Object Type: integer "name" : "", #No Desc. Object Type: string @@ -171,6 +176,7 @@ def replace_template_pass_by_id(self, id="", body=({})): "relevant_date_template" : "", #No Desc. Object Type: string "associated_apps" : False, #No Desc. Object Type: boolean "pass_apps" : False, #No Desc. Object Type: array + } """ url_path = "/template/pass/{id}" @@ -210,12 +216,14 @@ def new_guest_authentication(self, body=({})): Required Body Parameters:['g_radius_internal_auth_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "g_admin_access_guest_require_https" : False, #If checked, HTTP access by guests will be redirected to use HTTPS instead. Object Type: boolean "change_of_authorization" : False, #Global to automatically send disconnects when enabled/role values change.Requires a NAS Type supporting RFC-3576. Object Type: boolean "g_radius_default_vendor" : "", #Select the default type for network access servers. Object Type: string "g_radius_server_bind_3576" : "", #Force a specific bind address for RFC-3576 requests. This may be needed in an AirGroup environment.Defaults to '0.0.0.0' or '::' depending on your network. Object Type: string "g_radius_internal_auth_type" : "", #Controls the RADIUS authentication type used for internal RADIUS authentication requests. Object Type: string + } """ url_path = "/guest/authentication" @@ -231,12 +239,14 @@ def update_guest_authentication(self, body=({})): Required Body Parameters:['g_radius_internal_auth_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "g_admin_access_guest_require_https" : False, #If checked, HTTP access by guests will be redirected to use HTTPS instead. Object Type: boolean "change_of_authorization" : False, #Global to automatically send disconnects when enabled/role values change.Requires a NAS Type supporting RFC-3576. Object Type: boolean "g_radius_default_vendor" : "", #Select the default type for network access servers. Object Type: string "g_radius_server_bind_3576" : "", #Force a specific bind address for RFC-3576 requests. This may be needed in an AirGroup environment.Defaults to '0.0.0.0' or '::' depending on your network. Object Type: string "g_radius_internal_auth_type" : "", #Controls the RADIUS authentication type used for internal RADIUS authentication requests. Object Type: string + } """ url_path = "/guest/authentication" @@ -261,6 +271,7 @@ def new_guestmanager(self, body=({})): Required Body Parameters:['random_username_method', 'random_username_length', 'random_password_method', 'random_password_length', 'guest_password_complexity', 'guest_password_minimum', 'guest_do_expire', 'guest_account_expiry_options', 'guest_modify_expire_time_options', 'guest_lifetime_options'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "random_username_method" : "", #The method used to generate random account usernames. Object Type: string "random_username_multi_prefix" : "", #Identifier string to prepend to usernames.Dynamic entries based on a user attribute can be entered as '_' + attribute. For example '_role_name'.The username length will determine the length of the numeric sequence only. Recommend 4. Object Type: string @@ -277,9 +288,9 @@ def new_guestmanager(self, body=({})): "guest_view_account_password" : False, #If selected, guest and device Wi-Fi passwords may be displayed to an operator.This is only possible if operators have the View Passwords privilege as well. Object Type: boolean "guest_do_expire" : 0, #Default action to take when the expire_time is reached. Note that a logout can only occur if the NAS is RFC-3576 compliant. Object Type: integer - "guest_account_expiry_options" : {}, The available options to select from when choosing the expiration time of a guest account (expire_after). #Expiration times are specified in hours. Object Type: object - "guest_modify_expire_time_options" : {}, The available options to select from when modifying an account's expiration (modify_expire_time). #Note some items may be dynamically removed based on the state of the account. Object Type: object - "guest_lifetime_options" : {}, The available options to select from when choosing the lifetime of a guest account (expire_postlogin). #Lifetime values are specified in minutes. Object Type: object + "guest_account_expiry_options" : {}, #The available options to select from when choosing the expiration time of a guest account (expire_after). #Expiration times are specified in hours. Object Type: object + "guest_modify_expire_time_options" : {}, #The available options to select from when modifying an account's expiration (modify_expire_time). #Note some items may be dynamically removed based on the state of the account. Object Type: object + "guest_lifetime_options" : {}, #The available options to select from when choosing the lifetime of a guest account (expire_postlogin). #Lifetime values are specified in minutes. Object Type: object "g_action_notify_account_expire_enabled" : False, #If checked, users will receive an email notification when their device’s network credentials are due to expire.Accounts must contain the ’expired_notify_status’ field with a value of ’1’. Once a notification is sent, this field will show as ’0’. Object Type: boolean "g_action_notify_account_expiration_duration" : 0, #Account expiration emails are sent this many days before the account expires. Enter a value between 1 and 30. Object Type: integer @@ -305,6 +316,7 @@ def new_guestmanager(self, body=({})): "guest_active_sessions" : 0, #Enable limiting the number of active sessions a guest account may have. Enter 0 to allow an unlimited number of sessions. Object Type: integer "guest_about_guest_network_access" : "", #Template code to display on the Guest Manager start page, under the“About Guest Network Access” heading. Leave blank to use the default text,or enter a hyphen (“-”) to remove the default text and the heading. Object Type: string + } """ url_path = "/guestmanager" @@ -320,6 +332,7 @@ def update_guestmanager(self, body=({})): Required Body Parameters:['random_username_method', 'random_username_length', 'random_password_method', 'random_password_length', 'guest_password_complexity', 'guest_password_minimum', 'guest_do_expire', 'guest_account_expiry_options', 'guest_modify_expire_time_options', 'guest_lifetime_options'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "random_username_method" : "", #The method used to generate random account usernames. Object Type: string "random_username_multi_prefix" : "", #Identifier string to prepend to usernames.Dynamic entries based on a user attribute can be entered as '_' + attribute. For example '_role_name'.The username length will determine the length of the numeric sequence only. Recommend 4. Object Type: string @@ -336,9 +349,9 @@ def update_guestmanager(self, body=({})): "guest_view_account_password" : False, #If selected, guest and device Wi-Fi passwords may be displayed to an operator.This is only possible if operators have the View Passwords privilege as well. Object Type: boolean "guest_do_expire" : 0, #Default action to take when the expire_time is reached. Note that a logout can only occur if the NAS is RFC-3576 compliant. Object Type: integer - "guest_account_expiry_options" : {}, The available options to select from when choosing the expiration time of a guest account (expire_after). #Expiration times are specified in hours. Object Type: object - "guest_modify_expire_time_options" : {}, The available options to select from when modifying an account's expiration (modify_expire_time). #Note some items may be dynamically removed based on the state of the account. Object Type: object - "guest_lifetime_options" : {}, The available options to select from when choosing the lifetime of a guest account (expire_postlogin). #Lifetime values are specified in minutes. Object Type: object + "guest_account_expiry_options" : {}, #The available options to select from when choosing the expiration time of a guest account (expire_after). #Expiration times are specified in hours. Object Type: object + "guest_modify_expire_time_options" : {}, #The available options to select from when modifying an account's expiration (modify_expire_time). #Note some items may be dynamically removed based on the state of the account. Object Type: object + "guest_lifetime_options" : {}, #The available options to select from when choosing the lifetime of a guest account (expire_postlogin). #Lifetime values are specified in minutes. Object Type: object "g_action_notify_account_expire_enabled" : False, #If checked, users will receive an email notification when their device’s network credentials are due to expire.Accounts must contain the ’expired_notify_status’ field with a value of ’1’. Once a notification is sent, this field will show as ’0’. Object Type: boolean "g_action_notify_account_expiration_duration" : 0, #Account expiration emails are sent this many days before the account expires. Enter a value between 1 and 30. Object Type: integer @@ -364,6 +377,7 @@ def update_guestmanager(self, body=({})): "guest_active_sessions" : 0, #Enable limiting the number of active sessions a guest account may have. Enter 0 to allow an unlimited number of sessions. Object Type: integer "guest_about_guest_network_access" : "", #Template code to display on the Guest Manager start page, under the“About Guest Network Access” heading. Leave blank to use the default text,or enter a hyphen (“-”) to remove the default text and the heading. Object Type: string + } """ url_path = "/guestmanager" @@ -403,6 +417,7 @@ def new_template_print(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric ID of the template. Object Type: integer "name" : "", #Name of the template. Object Type: string @@ -419,6 +434,7 @@ def new_template_print(self, body=({})): "wizard_fields" : "", #Visitor account fields. Object Type: string "wizard_notes" : "", #Notes to display on the template. Object Type: string "wizard_footer" : "", #Footer text to display on the template. Object Type: string + } """ url_path = "/template/print" @@ -447,6 +463,7 @@ def update_template_print_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric ID of the template. Object Type: integer "name" : "", #Name of the template. Object Type: string @@ -463,6 +480,7 @@ def update_template_print_by_id(self, id="", body=({})): "wizard_fields" : "", #Visitor account fields. Object Type: string "wizard_notes" : "", #Notes to display on the template. Object Type: string "wizard_footer" : "", #Footer text to display on the template. Object Type: string + } """ url_path = "/template/print/{id}" @@ -482,6 +500,7 @@ def replace_template_print_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric ID of the template. Object Type: integer "name" : "", #Name of the template. Object Type: string @@ -498,6 +517,7 @@ def replace_template_print_by_id(self, id="", body=({})): "wizard_fields" : "", #Visitor account fields. Object Type: string "wizard_notes" : "", #Notes to display on the template. Object Type: string "wizard_footer" : "", #Footer text to display on the template. Object Type: string + } """ url_path = "/template/print/{id}" @@ -550,6 +570,7 @@ def new_weblogin(self, body=({})): Required Body Parameters:['name', 'vendor_preset', 'form_action', 'form_method', 'form_username', 'form_password', 'form_password_encryption', 'access_if_denied', 'login_delay', 'login_skin', 'login_pre_auth_check'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Unique ID of the web login. Object Type: integer "name" : "", #Enter a name for this web login page. Object Type: string @@ -583,7 +604,7 @@ def new_weblogin(self, body=({})): "login_header" : "", #HTML template code displayed before the login form. Object Type: string "login_footer" : "", #HTML template code displayed after the login form. Object Type: string "login_message" : "", #HTML template code displayed while the login attempt is in progress. Object Type: string - "login_delay" : "" #variable unknown: , #The time in seconds to delay while displaying the login message. Object Type: number + "login_delay" : "", #The time in seconds to delay while displaying the login message. Object Type: number "login_skin" : "", #Choose the skin to use when this web login page is displayed. Object Type: string "login_terms_require" : False, #If checked, the user will be forced to accept a Terms and Conditions checkbox. Object Type: boolean "login_terms_label" : "", #The form label for the terms checkbox. Leave blank to use the default (Terms:). Object Type: string @@ -639,6 +660,7 @@ def new_weblogin(self, body=({})): "mfa_mc_client_secret" : "", #No Desc. Object Type: string "mfa_header_html" : "", #HTML template code displayed before the provider’s vendor-specific authentication area. Object Type: string "mfa_footer_html" : "", #HTML template code displayed after the provider’s vendor-specific authentication area. Object Type: string + } """ url_path = "/weblogin" @@ -667,6 +689,7 @@ def update_weblogin_by_id(self, id="", body=({})): Required Body Parameters:['name', 'vendor_preset', 'form_action', 'form_method', 'form_username', 'form_password', 'form_password_encryption', 'access_if_denied', 'login_delay', 'login_skin', 'login_pre_auth_check'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Unique ID of the web login. Object Type: integer "name" : "", #Enter a name for this web login page. Object Type: string @@ -700,7 +723,7 @@ def update_weblogin_by_id(self, id="", body=({})): "login_header" : "", #HTML template code displayed before the login form. Object Type: string "login_footer" : "", #HTML template code displayed after the login form. Object Type: string "login_message" : "", #HTML template code displayed while the login attempt is in progress. Object Type: string - "login_delay" : "" #variable unknown: , #The time in seconds to delay while displaying the login message. Object Type: number + "login_delay" : "", #The time in seconds to delay while displaying the login message. Object Type: number "login_skin" : "", #Choose the skin to use when this web login page is displayed. Object Type: string "login_terms_require" : False, #If checked, the user will be forced to accept a Terms and Conditions checkbox. Object Type: boolean "login_terms_label" : "", #The form label for the terms checkbox. Leave blank to use the default (Terms:). Object Type: string @@ -756,6 +779,7 @@ def update_weblogin_by_id(self, id="", body=({})): "mfa_mc_client_secret" : "", #No Desc. Object Type: string "mfa_header_html" : "", #HTML template code displayed before the provider’s vendor-specific authentication area. Object Type: string "mfa_footer_html" : "", #HTML template code displayed after the provider’s vendor-specific authentication area. Object Type: string + } """ url_path = "/weblogin/{id}" @@ -775,6 +799,7 @@ def replace_weblogin_by_id(self, id="", body=({})): Required Body Parameters:['name', 'vendor_preset', 'form_action', 'form_method', 'form_username', 'form_password', 'form_password_encryption', 'access_if_denied', 'login_delay', 'login_skin', 'login_pre_auth_check'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Unique ID of the web login. Object Type: integer "name" : "", #Enter a name for this web login page. Object Type: string @@ -808,7 +833,7 @@ def replace_weblogin_by_id(self, id="", body=({})): "login_header" : "", #HTML template code displayed before the login form. Object Type: string "login_footer" : "", #HTML template code displayed after the login form. Object Type: string "login_message" : "", #HTML template code displayed while the login attempt is in progress. Object Type: string - "login_delay" : "" #variable unknown: , #The time in seconds to delay while displaying the login message. Object Type: number + "login_delay" : "", #The time in seconds to delay while displaying the login message. Object Type: number "login_skin" : "", #Choose the skin to use when this web login page is displayed. Object Type: string "login_terms_require" : False, #If checked, the user will be forced to accept a Terms and Conditions checkbox. Object Type: boolean "login_terms_label" : "", #The form label for the terms checkbox. Leave blank to use the default (Terms:). Object Type: string @@ -864,6 +889,7 @@ def replace_weblogin_by_id(self, id="", body=({})): "mfa_mc_client_secret" : "", #No Desc. Object Type: string "mfa_header_html" : "", #HTML template code displayed before the provider’s vendor-specific authentication area. Object Type: string "mfa_footer_html" : "", #HTML template code displayed after the provider’s vendor-specific authentication area. Object Type: string + } """ url_path = "/weblogin/{id}" @@ -907,6 +933,7 @@ def update_weblogin_page_name_by_page_name(self, page_name="", body=({})): Required Body Parameters:['name', 'vendor_preset', 'form_action', 'form_method', 'form_username', 'form_password', 'form_password_encryption', 'access_if_denied', 'login_delay', 'login_skin', 'login_pre_auth_check'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Unique ID of the web login. Object Type: integer "name" : "", #Enter a name for this web login page. Object Type: string @@ -940,7 +967,7 @@ def update_weblogin_page_name_by_page_name(self, page_name="", body=({})): "login_header" : "", #HTML template code displayed before the login form. Object Type: string "login_footer" : "", #HTML template code displayed after the login form. Object Type: string "login_message" : "", #HTML template code displayed while the login attempt is in progress. Object Type: string - "login_delay" : "" #variable unknown: , #The time in seconds to delay while displaying the login message. Object Type: number + "login_delay" : "", #The time in seconds to delay while displaying the login message. Object Type: number "login_skin" : "", #Choose the skin to use when this web login page is displayed. Object Type: string "login_terms_require" : False, #If checked, the user will be forced to accept a Terms and Conditions checkbox. Object Type: boolean "login_terms_label" : "", #The form label for the terms checkbox. Leave blank to use the default (Terms:). Object Type: string @@ -996,6 +1023,7 @@ def update_weblogin_page_name_by_page_name(self, page_name="", body=({})): "mfa_mc_client_secret" : "", #No Desc. Object Type: string "mfa_header_html" : "", #HTML template code displayed before the provider’s vendor-specific authentication area. Object Type: string "mfa_footer_html" : "", #HTML template code displayed after the provider’s vendor-specific authentication area. Object Type: string + } """ url_path = "/weblogin/page-name/{page_name}" @@ -1015,6 +1043,7 @@ def replace_weblogin_page_name_by_page_name(self, page_name="", body=({})): Required Body Parameters:['name', 'vendor_preset', 'form_action', 'form_method', 'form_username', 'form_password', 'form_password_encryption', 'access_if_denied', 'login_delay', 'login_skin', 'login_pre_auth_check'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Unique ID of the web login. Object Type: integer "name" : "", #Enter a name for this web login page. Object Type: string @@ -1048,7 +1077,7 @@ def replace_weblogin_page_name_by_page_name(self, page_name="", body=({})): "login_header" : "", #HTML template code displayed before the login form. Object Type: string "login_footer" : "", #HTML template code displayed after the login form. Object Type: string "login_message" : "", #HTML template code displayed while the login attempt is in progress. Object Type: string - "login_delay" : "" #variable unknown: , #The time in seconds to delay while displaying the login message. Object Type: number + "login_delay" : "", #The time in seconds to delay while displaying the login message. Object Type: number "login_skin" : "", #Choose the skin to use when this web login page is displayed. Object Type: string "login_terms_require" : False, #If checked, the user will be forced to accept a Terms and Conditions checkbox. Object Type: boolean "login_terms_label" : "", #The form label for the terms checkbox. Leave blank to use the default (Terms:). Object Type: string @@ -1104,6 +1133,7 @@ def replace_weblogin_page_name_by_page_name(self, page_name="", body=({})): "mfa_mc_client_secret" : "", #No Desc. Object Type: string "mfa_header_html" : "", #HTML template code displayed before the provider’s vendor-specific authentication area. Object Type: string "mfa_footer_html" : "", #HTML template code displayed after the provider’s vendor-specific authentication area. Object Type: string + } """ url_path = "/weblogin/page-name/{page_name}" diff --git a/pyclearpass/api_identities.py b/pyclearpass/api_identities.py index f9eaaec..29716ed 100644 --- a/pyclearpass/api_identities.py +++ b/pyclearpass/api_identities.py @@ -40,6 +40,7 @@ def new_api_client(self, body=({})): Required Body Parameters:['access_token_lifetime', 'access_token_lifetime_units', 'client_id', 'id', 'refresh_token_lifetime', 'refresh_token_lifetime_units'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "access_lifetime" : "", #Lifetime of an OAuth2 access token. Object Type: string "access_token_lifetime" : "", #Specify the lifetime of an OAuth2 access token. Object Type: string @@ -62,6 +63,7 @@ def new_api_client(self, body=({})): "refresh_token_lifetime_units" : "", #Specify the lifetime of an OAuth2 refresh token. Object Type: string "scope" : "", #Not supported at this time. Object Type: string "user_id" : "", #Not supported at this time. Object Type: string + } """ url_path = "/api-client" @@ -90,6 +92,7 @@ def update_api_client_by_client_id(self, client_id="", body=({})): Required Body Parameters:['access_token_lifetime', 'access_token_lifetime_units', 'client_id', 'id', 'refresh_token_lifetime', 'refresh_token_lifetime_units'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "access_lifetime" : "", #Lifetime of an OAuth2 access token. Object Type: string "access_token_lifetime" : "", #Specify the lifetime of an OAuth2 access token. Object Type: string @@ -112,6 +115,7 @@ def update_api_client_by_client_id(self, client_id="", body=({})): "refresh_token_lifetime_units" : "", #Specify the lifetime of an OAuth2 refresh token. Object Type: string "scope" : "", #Not supported at this time. Object Type: string "user_id" : "", #Not supported at this time. Object Type: string + } """ url_path = "/api-client/{client_id}" @@ -131,6 +135,7 @@ def replace_api_client_by_client_id(self, client_id="", body=({})): Required Body Parameters:['access_token_lifetime', 'access_token_lifetime_units', 'client_id', 'id', 'refresh_token_lifetime', 'refresh_token_lifetime_units'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "access_lifetime" : "", #Lifetime of an OAuth2 access token. Object Type: string "access_token_lifetime" : "", #Specify the lifetime of an OAuth2 access token. Object Type: string @@ -153,6 +158,7 @@ def replace_api_client_by_client_id(self, client_id="", body=({})): "refresh_token_lifetime_units" : "", #Specify the lifetime of an OAuth2 refresh token. Object Type: string "scope" : "", #Not supported at this time. Object Type: string "user_id" : "", #Not supported at this time. Object Type: string + } """ url_path = "/api-client/{client_id}" @@ -284,6 +290,7 @@ def new_device(self, change_of_authorization="", body=({})): Required Body Parameters:['mac', 'role_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "current_state" : "", #Read-only property indicating the current state of the account. Object Type: string @@ -300,6 +307,7 @@ def new_device(self, change_of_authorization="", body=({})): "start_time" : "", #Time at which the account will be enabled. Object Type: string "visitor_name" : "", #Name to display for the account. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/device" @@ -333,6 +341,7 @@ def update_device_by_device_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "current_state" : "", #Read-only property indicating the current state of the account. Object Type: string @@ -353,6 +362,7 @@ def update_device_by_device_id( "username" : "", #No Desc. Object Type: string "visitor_name" : "", #Name to display for the account. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/device/{device_id}" @@ -377,6 +387,7 @@ def replace_device_by_device_id( Required Body Parameters:['mac', 'role_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "current_state" : "", #Read-only property indicating the current state of the account. Object Type: string @@ -394,6 +405,7 @@ def replace_device_by_device_id( "start_time" : "", #Time at which the account will be enabled. Object Type: string "visitor_name" : "", #Name to display for the account. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/device/{device_id}" @@ -445,6 +457,7 @@ def update_device_mac_by_macaddr( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "current_state" : "", #Read-only property indicating the current state of the account. Object Type: string @@ -465,6 +478,7 @@ def update_device_mac_by_macaddr( "username" : "", #No Desc. Object Type: string "visitor_name" : "", #Name to display for the account. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/device/mac/{macaddr}" @@ -489,6 +503,7 @@ def replace_device_mac_by_macaddr( Required Body Parameters:['mac', 'role_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "current_state" : "", #Read-only property indicating the current state of the account. Object Type: string @@ -506,6 +521,7 @@ def replace_device_mac_by_macaddr( "start_time" : "", #Time at which the account will be enabled. Object Type: string "visitor_name" : "", #Name to display for the account. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/device/mac/{macaddr}" @@ -563,12 +579,14 @@ def new_endpoint(self, body=({})): Required Body Parameters:['mac_address', 'status'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "mac_address" : "", #MAC Address of the endpoint. Object Type: string "description" : "", #Description of the endpoint. Object Type: string "status" : "", #Status of the endpoint. Object Type: string "device_insight_tags" : "", #List of Device Insight Tags. Object Type: string "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the endpoint. Object Type: object + } """ url_path = "/endpoint" @@ -597,12 +615,14 @@ def update_endpoint_by_endpoint_id(self, endpoint_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "mac_address" : "", #MAC Address of the endpoint. Object Type: string "description" : "", #Description of the endpoint. Object Type: string "status" : "", #Status of the endpoint. Object Type: string "device_insight_tags" : "", #List of Device Insight Tags. Object Type: string "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the endpoint. Object Type: object + } """ url_path = "/endpoint/{endpoint_id}" @@ -622,12 +642,14 @@ def replace_endpoint_by_endpoint_id(self, endpoint_id="", body=({})): Required Body Parameters:['mac_address', 'status'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "mac_address" : "", #MAC Address of the endpoint. Object Type: string "description" : "", #Description of the endpoint. Object Type: string "status" : "", #Status of the endpoint. Object Type: string "device_insight_tags" : "", #List of Device Insight Tags. Object Type: string "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the endpoint. Object Type: object + } """ url_path = "/endpoint/{endpoint_id}" @@ -671,12 +693,14 @@ def update_endpoint_mac_address_by_mac_address(self, mac_address="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "mac_address" : "", #MAC Address of the endpoint. Object Type: string "description" : "", #Description of the endpoint. Object Type: string "status" : "", #Status of the endpoint. Object Type: string "device_insight_tags" : "", #List of Device Insight Tags. Object Type: string "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the endpoint. Object Type: object + } """ url_path = "/endpoint/mac-address/{mac_address}" @@ -696,12 +720,14 @@ def replace_endpoint_mac_address_by_mac_address(self, mac_address="", body=({})) Required Body Parameters:['mac_address', 'status'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "mac_address" : "", #MAC Address of the endpoint. Object Type: string "description" : "", #Description of the endpoint. Object Type: string "status" : "", #Status of the endpoint. Object Type: string "device_insight_tags" : "", #List of Device Insight Tags. Object Type: string "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the endpoint. Object Type: object + } """ url_path = "/endpoint/mac-address/{mac_address}" @@ -756,6 +782,7 @@ def new_external_account(self, body=({})): Required Body Parameters:['name', 'type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the external account. Object Type: string "type" : "", #Type of the external account. Object Type: string @@ -771,6 +798,7 @@ def new_external_account(self, body=({})): "auth_key" : "", #Authorization key for V3 SNMP external account. Object Type: string "priv_protocol" : "", #Privacy protocol for V3 SNMP external account. Object Type: string "priv_key" : "", #Privacy key for V3 SNMP external account. Object Type: string + } """ url_path = "/external-account" @@ -801,6 +829,7 @@ def update_external_account_by_external_account_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the external account. Object Type: string "type" : "", #Type of the external account. Object Type: string @@ -816,6 +845,7 @@ def update_external_account_by_external_account_id( "auth_key" : "", #Authorization key for V3 SNMP external account. Object Type: string "priv_protocol" : "", #Privacy protocol for V3 SNMP external account. Object Type: string "priv_key" : "", #Privacy key for V3 SNMP external account. Object Type: string + } """ url_path = "/external-account/{external_account_id}" @@ -837,6 +867,7 @@ def replace_external_account_by_external_account_id( Required Body Parameters:['name', 'type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the external account. Object Type: string "type" : "", #Type of the external account. Object Type: string @@ -852,6 +883,7 @@ def replace_external_account_by_external_account_id( "auth_key" : "", #Authorization key for V3 SNMP external account. Object Type: string "priv_protocol" : "", #Privacy protocol for V3 SNMP external account. Object Type: string "priv_key" : "", #Privacy key for V3 SNMP external account. Object Type: string + } """ url_path = "/external-account/{external_account_id}" @@ -895,6 +927,7 @@ def update_external_account_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the external account. Object Type: string "type" : "", #Type of the external account. Object Type: string @@ -910,6 +943,7 @@ def update_external_account_name_by_name(self, name="", body=({})): "auth_key" : "", #Authorization key for V3 SNMP external account. Object Type: string "priv_protocol" : "", #Privacy protocol for V3 SNMP external account. Object Type: string "priv_key" : "", #Privacy key for V3 SNMP external account. Object Type: string + } """ url_path = "/external-account/name/{name}" @@ -929,6 +963,7 @@ def replace_external_account_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the external account. Object Type: string "type" : "", #Type of the external account. Object Type: string @@ -944,6 +979,7 @@ def replace_external_account_name_by_name(self, name="", body=({})): "auth_key" : "", #Authorization key for V3 SNMP external account. Object Type: string "priv_protocol" : "", #Privacy protocol for V3 SNMP external account. Object Type: string "priv_key" : "", #Privacy key for V3 SNMP external account. Object Type: string + } """ url_path = "/external-account/name/{name}" @@ -997,6 +1033,7 @@ def new_guest(self, change_of_authorization="", body=({})): Required Body Parameters:['username', 'password', 'role_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "do_expire" : 0, #Action to take when the expire_time is reached. Object Type: integer @@ -1017,6 +1054,7 @@ def new_guest(self, change_of_authorization="", body=({})): "visitor_name" : "", #The guest’s full name. Object Type: string "visitor_phone" : "", #The guest’s contact telephone number. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/guest" @@ -1050,6 +1088,7 @@ def update_guest_by_guest_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "do_expire" : 0, #Action to take when the expire_time is reached. Object Type: integer @@ -1071,6 +1110,7 @@ def update_guest_by_guest_id( "visitor_name" : "", #The guest’s full name. Object Type: string "visitor_phone" : "", #The guest’s contact telephone number. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/guest/{guest_id}" @@ -1095,6 +1135,7 @@ def replace_guest_by_guest_id( Required Body Parameters:['username', 'password', 'role_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "do_expire" : 0, #Action to take when the expire_time is reached. Object Type: integer @@ -1116,6 +1157,7 @@ def replace_guest_by_guest_id( "visitor_name" : "", #The guest’s full name. Object Type: string "visitor_phone" : "", #The guest’s contact telephone number. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/guest/{guest_id}" @@ -1167,6 +1209,7 @@ def update_guest_username_by_username( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "do_expire" : 0, #Action to take when the expire_time is reached. Object Type: integer @@ -1188,6 +1231,7 @@ def update_guest_username_by_username( "visitor_name" : "", #The guest’s full name. Object Type: string "visitor_phone" : "", #The guest’s contact telephone number. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/guest/username/{username}" @@ -1212,6 +1256,7 @@ def replace_guest_username_by_username( Required Body Parameters:['username', 'password', 'role_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "create_time" : "", #Time at which the account was created. Object Type: string "do_expire" : 0, #Action to take when the expire_time is reached. Object Type: integer @@ -1233,6 +1278,7 @@ def replace_guest_username_by_username( "visitor_name" : "", #The guest’s full name. Object Type: string "visitor_phone" : "", #The guest’s contact telephone number. Object Type: string "..." : "", #Additional properties (custom fields) may be stored with the account. Object Type: string + } """ url_path = "/guest/username/{username}" @@ -1294,6 +1340,7 @@ def new_local_user(self, body=({})): Required Body Parameters:['user_id', 'password', 'username', 'role_name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "user_id" : "", #Unique user id of the local user. Object Type: string "password" : "", #Password of the local user. Object Type: string @@ -1302,6 +1349,7 @@ def new_local_user(self, body=({})): "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "change_pwd_next_login" : False, #Flag indicating if the password change is required in next login. Object Type: boolean "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the local user account. Object Type: object + } """ url_path = "/local-user" @@ -1330,6 +1378,7 @@ def update_local_user_by_local_user_id(self, local_user_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "user_id" : "", #Unique user id of the local user. Object Type: string "password" : "", #Password of the local user. Object Type: string @@ -1338,6 +1387,7 @@ def update_local_user_by_local_user_id(self, local_user_id="", body=({})): "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "change_pwd_next_login" : False, #Flag indicating if the password change is required in next login. Object Type: boolean "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the local user account. Object Type: object + } """ url_path = "/local-user/{local_user_id}" @@ -1357,6 +1407,7 @@ def replace_local_user_by_local_user_id(self, local_user_id="", body=({})): Required Body Parameters:['user_id', 'password', 'username', 'role_name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "user_id" : "", #Unique user id of the local user. Object Type: string "password" : "", #Password of the local user. Object Type: string @@ -1365,6 +1416,7 @@ def replace_local_user_by_local_user_id(self, local_user_id="", body=({})): "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "change_pwd_next_login" : False, #Flag indicating if the password change is required in next login. Object Type: boolean "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the local user account. Object Type: object + } """ url_path = "/local-user/{local_user_id}" @@ -1408,6 +1460,7 @@ def update_local_user_user_id_by_user_id(self, user_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "user_id" : "", #Unique user id of the local user. Object Type: string "password" : "", #Password of the local user. Object Type: string @@ -1416,6 +1469,7 @@ def update_local_user_user_id_by_user_id(self, user_id="", body=({})): "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "change_pwd_next_login" : False, #Flag indicating if the password change is required in next login. Object Type: boolean "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the local user account. Object Type: object + } """ url_path = "/local-user/user-id/{user_id}" @@ -1435,6 +1489,7 @@ def replace_local_user_user_id_by_user_id(self, user_id="", body=({})): Required Body Parameters:['user_id', 'password', 'username', 'role_name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "user_id" : "", #Unique user id of the local user. Object Type: string "password" : "", #Password of the local user. Object Type: string @@ -1443,6 +1498,7 @@ def replace_local_user_user_id_by_user_id(self, user_id="", body=({})): "enabled" : False, #Flag indicating if the account is enabled. Object Type: boolean "change_pwd_next_login" : False, #Flag indicating if the password change is required in next login. Object Type: boolean "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the local user account. Object Type: object + } """ url_path = "/local-user/user-id/{user_id}" @@ -1497,6 +1553,7 @@ def new_static_host_list(self, body=({})): Required Body Parameters:['name', 'host_format', 'host_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the static host list. Object Type: string "description" : "", #Description of the static host list. Object Type: string @@ -1504,6 +1561,7 @@ def new_static_host_list(self, body=({})): "host_type" : "", #Host type of the static host list. Object Type: string "value" : "", #Value for the host format "Subnet" and "Regular Expression". Object Type: string "host_entries" : {}, #List of host entries (Address and Description) for the host format "List". For example, "host_entries":[{"host_address": "10.21.11.117", "host_address_desc" : "My host address description."}, {..} ..]. Object Type: object + } """ url_path = "/static-host-list" @@ -1534,6 +1592,7 @@ def update_static_host_list_by_static_host_list_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the static host list. Object Type: string "description" : "", #Description of the static host list. Object Type: string @@ -1541,6 +1600,7 @@ def update_static_host_list_by_static_host_list_id( "host_type" : "", #Host type of the static host list. Object Type: string "value" : "", #Value for the host format "Subnet" and "Regular Expression". Object Type: string "host_entries" : {}, #List of host entries (Address and Description) for the host format "List". For example, "host_entries":[{"host_address": "10.21.11.117", "host_address_desc" : "My host address description."}, {..} ..]. Object Type: object + } """ url_path = "/static-host-list/{static_host_list_id}" @@ -1562,6 +1622,7 @@ def replace_static_host_list_by_static_host_list_id( Required Body Parameters:['name', 'host_format', 'host_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the static host list. Object Type: string "description" : "", #Description of the static host list. Object Type: string @@ -1569,6 +1630,7 @@ def replace_static_host_list_by_static_host_list_id( "host_type" : "", #Host type of the static host list. Object Type: string "value" : "", #Value for the host format "Subnet" and "Regular Expression". Object Type: string "host_entries" : {}, #List of host entries (Address and Description) for the host format "List". For example, "host_entries":[{"host_address": "10.21.11.117", "host_address_desc" : "My host address description."}, {..} ..]. Object Type: object + } """ url_path = "/static-host-list/{static_host_list_id}" @@ -1612,6 +1674,7 @@ def update_static_host_list_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the static host list. Object Type: string "description" : "", #Description of the static host list. Object Type: string @@ -1619,6 +1682,7 @@ def update_static_host_list_name_by_name(self, name="", body=({})): "host_type" : "", #Host type of the static host list. Object Type: string "value" : "", #Value for the host format "Subnet" and "Regular Expression". Object Type: string "host_entries" : {}, #List of host entries (Address and Description) for the host format "List". For example, "host_entries":[{"host_address": "10.21.11.117", "host_address_desc" : "My host address description."}, {..} ..]. Object Type: object + } """ url_path = "/static-host-list/name/{name}" @@ -1638,6 +1702,7 @@ def replace_static_host_list_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'host_format', 'host_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the static host list. Object Type: string "description" : "", #Description of the static host list. Object Type: string @@ -1645,6 +1710,7 @@ def replace_static_host_list_name_by_name(self, name="", body=({})): "host_type" : "", #Host type of the static host list. Object Type: string "value" : "", #Value for the host format "Subnet" and "Regular Expression". Object Type: string "host_entries" : {}, #List of host entries (Address and Description) for the host format "List". For example, "host_entries":[{"host_address": "10.21.11.117", "host_address_desc" : "My host address description."}, {..} ..]. Object Type: object + } """ url_path = "/static-host-list/name/{name}" diff --git a/pyclearpass/api_insight.py b/pyclearpass/api_insight.py index 4d3a147..7a60021 100644 --- a/pyclearpass/api_insight.py +++ b/pyclearpass/api_insight.py @@ -34,6 +34,7 @@ def new_alert(self, body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory', 'email_targets', 'severity', 'threshold', 'interval', 'interval_unit'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the alert. Object Type: integer "name" : "", #Name of the alert. Object Type: string @@ -42,13 +43,14 @@ def new_alert(self, body=({})): "subcategory" : "", #Sub category is the template name of the alert. Object Type: string "email_targets" : {}, #Send alert notification to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send alert notification to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object - "config" : {}, Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object + "config" : {}, #Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object "severity" : "", #Severity of the alert, either "critical" or "warning". Object Type: string "threshold" : 0, #Triggering the alert when reaching the specified numeric threshold value. Object Type: integer "interval" : 0, #Triggering the alert at the numeric interval. Object Type: integer "interval_unit" : "", #Interval units either "minute" or "hour". Object Type: string "is_enabled" : False, #Enable/Disable the alert. Object Type: boolean "is_muted" : False, #Mute/Unmute the alert. Object Type: boolean + } """ url_path = "/alert" @@ -77,6 +79,7 @@ def update_alert_by_id(self, id="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory', 'email_targets', 'severity', 'threshold', 'interval', 'interval_unit'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the alert. Object Type: integer "name" : "", #Name of the alert. Object Type: string @@ -85,13 +88,14 @@ def update_alert_by_id(self, id="", body=({})): "subcategory" : "", #Sub category is the template name of the alert. Object Type: string "email_targets" : {}, #Send alert notification to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send alert notification to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object - "config" : {}, Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object + "config" : {}, #Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object "severity" : "", #Severity of the alert, either "critical" or "warning". Object Type: string "threshold" : 0, #Triggering the alert when reaching the specified numeric threshold value. Object Type: integer "interval" : 0, #Triggering the alert at the numeric interval. Object Type: integer "interval_unit" : "", #Interval units either "minute" or "hour". Object Type: string "is_enabled" : False, #Enable/Disable the alert. Object Type: boolean "is_muted" : False, #Mute/Unmute the alert. Object Type: boolean + } """ url_path = "/alert/{id}" @@ -111,6 +115,7 @@ def replace_alert_by_id(self, id="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory', 'email_targets', 'severity', 'threshold', 'interval', 'interval_unit'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the alert. Object Type: integer "name" : "", #Name of the alert. Object Type: string @@ -119,13 +124,14 @@ def replace_alert_by_id(self, id="", body=({})): "subcategory" : "", #Sub category is the template name of the alert. Object Type: string "email_targets" : {}, #Send alert notification to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send alert notification to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object - "config" : {}, Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object + "config" : {}, #Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object "severity" : "", #Severity of the alert, either "critical" or "warning". Object Type: string "threshold" : 0, #Triggering the alert when reaching the specified numeric threshold value. Object Type: integer "interval" : 0, #Triggering the alert at the numeric interval. Object Type: integer "interval_unit" : "", #Interval units either "minute" or "hour". Object Type: string "is_enabled" : False, #Enable/Disable the alert. Object Type: boolean "is_muted" : False, #Mute/Unmute the alert. Object Type: boolean + } """ url_path = "/alert/{id}" @@ -169,6 +175,7 @@ def update_alert_by_name(self, name="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory', 'email_targets', 'severity', 'threshold', 'interval', 'interval_unit'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the alert. Object Type: integer "name" : "", #Name of the alert. Object Type: string @@ -177,13 +184,14 @@ def update_alert_by_name(self, name="", body=({})): "subcategory" : "", #Sub category is the template name of the alert. Object Type: string "email_targets" : {}, #Send alert notification to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send alert notification to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object - "config" : {}, Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object + "config" : {}, #Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object "severity" : "", #Severity of the alert, either "critical" or "warning". Object Type: string "threshold" : 0, #Triggering the alert when reaching the specified numeric threshold value. Object Type: integer "interval" : 0, #Triggering the alert at the numeric interval. Object Type: integer "interval_unit" : "", #Interval units either "minute" or "hour". Object Type: string "is_enabled" : False, #Enable/Disable the alert. Object Type: boolean "is_muted" : False, #Mute/Unmute the alert. Object Type: boolean + } """ url_path = "/alert/{name}" @@ -203,6 +211,7 @@ def replace_alert_by_name(self, name="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory', 'email_targets', 'severity', 'threshold', 'interval', 'interval_unit'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the alert. Object Type: integer "name" : "", #Name of the alert. Object Type: string @@ -211,13 +220,14 @@ def replace_alert_by_name(self, name="", body=({})): "subcategory" : "", #Sub category is the template name of the alert. Object Type: string "email_targets" : {}, #Send alert notification to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send alert notification to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object - "config" : {}, Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object + "config" : {}, #Setting the alert filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } } #}. Object Type: object "severity" : "", #Severity of the alert, either "critical" or "warning". Object Type: string "threshold" : 0, #Triggering the alert when reaching the specified numeric threshold value. Object Type: integer "interval" : 0, #Triggering the alert at the numeric interval. Object Type: integer "interval_unit" : "", #Interval units either "minute" or "hour". Object Type: string "is_enabled" : False, #Enable/Disable the alert. Object Type: boolean "is_muted" : False, #Mute/Unmute the alert. Object Type: boolean + } """ url_path = "/alert/{name}" @@ -362,6 +372,7 @@ def new_report(self, body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the report. Object Type: integer "name" : "", #Name of the report. Object Type: string @@ -371,11 +382,12 @@ def new_report(self, body=({})): "email_targets" : {}, #Send report to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send report to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object "copy_remote" : False, #Enable to copy the report to the configured SCP/SFTP server. Object Type: boolean - "config" : {}, Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object - "schedule" : {}, Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object + "config" : {}, #Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object + "schedule" : {}, #Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object "begin_dt" : 0, #Collect the data for the report from this "begin_dt". Object Type: integer "end_dt" : "", #Collect the data for the report till this "end_dt". Object Type: string "is_enabled" : False, #Enable/Disable the report. Object Type: boolean + } """ url_path = "/report" @@ -404,6 +416,7 @@ def update_report_by_id(self, id="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the report. Object Type: integer "name" : "", #Name of the report. Object Type: string @@ -413,11 +426,12 @@ def update_report_by_id(self, id="", body=({})): "email_targets" : {}, #Send report to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send report to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object "copy_remote" : False, #Enable to copy the report to the configured SCP/SFTP server. Object Type: boolean - "config" : {}, Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object - "schedule" : {}, Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object + "config" : {}, #Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object + "schedule" : {}, #Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object "begin_dt" : 0, #Collect the data for the report from this "begin_dt". Object Type: integer "end_dt" : "", #Collect the data for the report till this "end_dt". Object Type: string "is_enabled" : False, #Enable/Disable the report. Object Type: boolean + } """ url_path = "/report/{id}" @@ -437,6 +451,7 @@ def replace_report_by_id(self, id="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the report. Object Type: integer "name" : "", #Name of the report. Object Type: string @@ -446,11 +461,12 @@ def replace_report_by_id(self, id="", body=({})): "email_targets" : {}, #Send report to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send report to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object "copy_remote" : False, #Enable to copy the report to the configured SCP/SFTP server. Object Type: boolean - "config" : {}, Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object - "schedule" : {}, Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object + "config" : {}, #Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object + "schedule" : {}, #Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object "begin_dt" : 0, #Collect the data for the report from this "begin_dt". Object Type: integer "end_dt" : "", #Collect the data for the report till this "end_dt". Object Type: string "is_enabled" : False, #Enable/Disable the report. Object Type: boolean + } """ url_path = "/report/{id}" @@ -494,6 +510,7 @@ def update_report_by_name(self, name="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the report. Object Type: integer "name" : "", #Name of the report. Object Type: string @@ -503,11 +520,12 @@ def update_report_by_name(self, name="", body=({})): "email_targets" : {}, #Send report to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send report to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object "copy_remote" : False, #Enable to copy the report to the configured SCP/SFTP server. Object Type: boolean - "config" : {}, Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object - "schedule" : {}, Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object + "config" : {}, #Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object + "schedule" : {}, #Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object "begin_dt" : 0, #Collect the data for the report from this "begin_dt". Object Type: integer "end_dt" : "", #Collect the data for the report till this "end_dt". Object Type: string "is_enabled" : False, #Enable/Disable the report. Object Type: boolean + } """ url_path = "/report/{name}" @@ -527,6 +545,7 @@ def replace_report_by_name(self, name="", body=({})): Required Body Parameters:['id', 'name', 'category', 'subcategory'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : 0, #Numeric id of the report. Object Type: integer "name" : "", #Name of the report. Object Type: string @@ -536,11 +555,12 @@ def replace_report_by_name(self, name="", body=({})): "email_targets" : {}, #Send report to the configured email targets, e.g. "email_targets":["...", "..."]. Object Type: object "sms_targets" : {}, #Send report to the configured SMS targets, e.g. "sms_targets":["...", "..."]. Object Type: object "copy_remote" : False, #Enable to copy the report to the configured SCP/SFTP server. Object Type: boolean - "config" : {}, Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object - "schedule" : {}, Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object + "config" : {}, #Setting the report filter configurations & adding CSV columns for the CSV report, e.g. "config": { "filter": { "auth.ap_name": { "operator": "EQUALS", "value": ["..."] }, "cppm_cluster.hostname": { "operator":"CONTAINS", "value":["...", "..."] } }, csv_cols": ["...", "...", "..."] #}. Object Type: object + "schedule" : {}, #Scheduling the report. Options are [noRepeat, daily, weekly, monthly], e.g. when running the report "now" itself => "schedule": {} - then "begin_dt" & "end_dt" are mandatory, when scheduling the report at "daily" => "schedule": {"freq": "daily", "hour": 12} when scheduling the report at "weekly" => "schedule": {"freq": "weekly", "day": 0, "hour": 12} when scheduling the report at "monthly" => "schedule": {"freq": "monthly", "date": 1, "hour": 12} #. Object Type: object "begin_dt" : 0, #Collect the data for the report from this "begin_dt". Object Type: integer "end_dt" : "", #Collect the data for the report till this "end_dt". Object Type: string "is_enabled" : False, #Enable/Disable the report. Object Type: boolean + } """ url_path = "/report/{name}" diff --git a/pyclearpass/api_integrations.py b/pyclearpass/api_integrations.py index 61863fb..09ec29b 100644 --- a/pyclearpass/api_integrations.py +++ b/pyclearpass/api_integrations.py @@ -40,6 +40,7 @@ def new_context_server_action(self, body=({})): Required Body Parameters:['server_type', 'action_name', 'http_method', 'url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type of the Context Server Action. Object Type: string "server_name" : "", #Server Name of the Context Server Action. Object Type: string @@ -53,6 +54,7 @@ def new_context_server_action(self, body=({})): "content" : "", #Content of the Context Server Action. Object Type: string "headers" : {}, #Headers(key/value pairs) of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1"},{"attr_name":"key2", "attr_value":"value2"}]). Object Type: object "attributes" : {}, #Attributes of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1", "is_sensitive":true},{"attr_name":"key2", "attr_value":"value2", "is_sensitive": false}]). Object Type: object + } """ url_path = "/context-server-action" @@ -85,6 +87,7 @@ def update_context_server_action_by_context_server_action_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type of the Context Server Action. Object Type: string "server_name" : "", #Server Name of the Context Server Action. Object Type: string @@ -98,6 +101,7 @@ def update_context_server_action_by_context_server_action_id( "content" : "", #Content of the Context Server Action. Object Type: string "headers" : {}, #Headers(key/value pairs) of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1"},{"attr_name":"key2", "attr_value":"value2"}]). Object Type: object "attributes" : {}, #Attributes of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1", "is_sensitive":true},{"attr_name":"key2", "attr_value":"value2", "is_sensitive": false}]). Object Type: object + } """ url_path = "/context-server-action/{context_server_action_id}" @@ -119,6 +123,7 @@ def replace_context_server_action_by_context_server_action_id( Required Body Parameters:['server_type', 'action_name', 'http_method', 'url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type of the Context Server Action. Object Type: string "server_name" : "", #Server Name of the Context Server Action. Object Type: string @@ -132,6 +137,7 @@ def replace_context_server_action_by_context_server_action_id( "content" : "", #Content of the Context Server Action. Object Type: string "headers" : {}, #Headers(key/value pairs) of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1"},{"attr_name":"key2", "attr_value":"value2"}]). Object Type: object "attributes" : {}, #Attributes of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1", "is_sensitive":true},{"attr_name":"key2", "attr_value":"value2", "is_sensitive": false}]). Object Type: object + } """ url_path = "/context-server-action/{context_server_action_id}" @@ -183,6 +189,7 @@ def update_context_server_action_by_server_type_action_name_action_name( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type of the Context Server Action. Object Type: string "server_name" : "", #Server Name of the Context Server Action. Object Type: string @@ -196,6 +203,7 @@ def update_context_server_action_by_server_type_action_name_action_name( "content" : "", #Content of the Context Server Action. Object Type: string "headers" : {}, #Headers(key/value pairs) of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1"},{"attr_name":"key2", "attr_value":"value2"}]). Object Type: object "attributes" : {}, #Attributes of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1", "is_sensitive":true},{"attr_name":"key2", "attr_value":"value2", "is_sensitive": false}]). Object Type: object + } """ url_path = "/context-server-action/{server_type}/action-name/{action_name}" @@ -218,6 +226,7 @@ def replace_context_server_action_by_server_type_action_name_action_name( Required Body Parameters:['server_type', 'action_name', 'http_method', 'url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type of the Context Server Action. Object Type: string "server_name" : "", #Server Name of the Context Server Action. Object Type: string @@ -231,6 +240,7 @@ def replace_context_server_action_by_server_type_action_name_action_name( "content" : "", #Content of the Context Server Action. Object Type: string "headers" : {}, #Headers(key/value pairs) of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1"},{"attr_name":"key2", "attr_value":"value2"}]). Object Type: object "attributes" : {}, #Attributes of the Context Server Action (e.g., [{"attr_name":"key1", "attr_value":"value1", "is_sensitive":true},{"attr_name":"key2", "attr_value":"value2", "is_sensitive": false}]). Object Type: object + } """ url_path = "/context-server-action/{server_type}/action-name/{action_name}" @@ -273,6 +283,7 @@ def new_device_insight(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "enable_device_insight" : False, #Enable/Disable Device Insight Integration. Object Type: boolean "activation_token" : "", #Registration Token. Object Type: string @@ -293,6 +304,7 @@ def new_device_insight(self, body=({})): "tags_for_disconnect" : "", #Tags for Disconnect. Object Type: string "radius_coa_action" : "", #Radius CoA action. Object Type: string "analyzer_admin_url" : "", #Analyzer Admin URL. Object Type: string + } """ url_path = "/device-insight" @@ -332,6 +344,7 @@ def new_endpoint_context_server(self, body=({})): Required Body Parameters:['server_type', 'server_name', 'server_base_url', 'auth_method', 'validate_server', 'status', 'bypass_proxy'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type. Object Type: string "server_name" : "", #Server Name. Object Type: string @@ -349,6 +362,7 @@ def new_endpoint_context_server(self, body=({})): "status" : False, #Enable Server. Object Type: boolean "ip_version" : "", #IP Version. Object Type: string "bypass_proxy" : False, #Enable to bypass proxy server. Object Type: boolean + } """ url_path = "/endpoint-context-server" @@ -381,6 +395,7 @@ def update_endpoint_context_server_by_endpoint_context_server_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type. Object Type: string "server_name" : "", #Server Name. Object Type: string @@ -398,6 +413,7 @@ def update_endpoint_context_server_by_endpoint_context_server_id( "status" : False, #Enable Server. Object Type: boolean "ip_version" : "", #IP Version. Object Type: string "bypass_proxy" : False, #Enable to bypass proxy server. Object Type: boolean + } """ url_path = "/endpoint-context-server/{endpoint_context_server_id}" @@ -419,6 +435,7 @@ def replace_endpoint_context_server_by_endpoint_context_server_id( Required Body Parameters:['server_type', 'server_name', 'server_base_url', 'auth_method', 'validate_server', 'status', 'bypass_proxy'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type. Object Type: string "server_name" : "", #Server Name. Object Type: string @@ -436,6 +453,7 @@ def replace_endpoint_context_server_by_endpoint_context_server_id( "status" : False, #Enable Server. Object Type: boolean "ip_version" : "", #IP Version. Object Type: string "bypass_proxy" : False, #Enable to bypass proxy server. Object Type: boolean + } """ url_path = "/endpoint-context-server/{endpoint_context_server_id}" @@ -483,6 +501,7 @@ def update_endpoint_context_server_server_name_by_server_name( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type. Object Type: string "server_name" : "", #Server Name. Object Type: string @@ -500,6 +519,7 @@ def update_endpoint_context_server_server_name_by_server_name( "status" : False, #Enable Server. Object Type: boolean "ip_version" : "", #IP Version. Object Type: string "bypass_proxy" : False, #Enable to bypass proxy server. Object Type: boolean + } """ url_path = "/endpoint-context-server/server-name/{server_name}" @@ -521,6 +541,7 @@ def replace_endpoint_context_server_server_name_by_server_name( Required Body Parameters:['server_type', 'server_name', 'server_base_url', 'auth_method', 'validate_server', 'status', 'bypass_proxy'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "server_type" : "", #Server Type. Object Type: string "server_name" : "", #Server Name. Object Type: string @@ -538,6 +559,7 @@ def replace_endpoint_context_server_server_name_by_server_name( "status" : False, #Enable Server. Object Type: boolean "ip_version" : "", #IP Version. Object Type: string "bypass_proxy" : False, #Enable to bypass proxy server. Object Type: boolean + } """ url_path = "/endpoint-context-server/server-name/{server_name}" @@ -620,6 +642,7 @@ def new_event_sources(self, body=({})): Required Body Parameters:['name', 'ipaddress', 'vendor', 'type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Event source Name. Object Type: string "description" : "", #Event source description. Object Type: string @@ -627,6 +650,7 @@ def new_event_sources(self, body=({})): "vendor" : "", #Vendor name. Object Type: string "type" : "", #Event source type. Object Type: string "enable" : False, #Enable event source. Object Type: boolean + } """ url_path = "/event-sources" @@ -655,6 +679,7 @@ def update_event_sources_by_event_sources_id(self, event_sources_id="", body=({} Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Event source Name. Object Type: string "description" : "", #Event source description. Object Type: string @@ -662,6 +687,7 @@ def update_event_sources_by_event_sources_id(self, event_sources_id="", body=({} "vendor" : "", #Vendor name. Object Type: string "type" : "", #Event source type. Object Type: string "enable" : False, #Enable event source. Object Type: boolean + } """ url_path = "/event-sources/{event_sources_id}" @@ -681,6 +707,7 @@ def replace_event_sources_by_event_sources_id(self, event_sources_id="", body=({ Required Body Parameters:['name', 'ipaddress', 'vendor', 'type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Event source Name. Object Type: string "description" : "", #Event source description. Object Type: string @@ -688,6 +715,7 @@ def replace_event_sources_by_event_sources_id(self, event_sources_id="", body=({ "vendor" : "", #Vendor name. Object Type: string "type" : "", #Event source type. Object Type: string "enable" : False, #Enable event source. Object Type: boolean + } """ url_path = "/event-sources/{event_sources_id}" @@ -731,6 +759,7 @@ def update_event_sources_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Event source Name. Object Type: string "description" : "", #Event source description. Object Type: string @@ -738,6 +767,7 @@ def update_event_sources_name_by_name(self, name="", body=({})): "vendor" : "", #Vendor name. Object Type: string "type" : "", #Event source type. Object Type: string "enable" : False, #Enable event source. Object Type: boolean + } """ url_path = "/event-sources/name/{name}" @@ -757,6 +787,7 @@ def replace_event_sources_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'ipaddress', 'vendor', 'type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Event source Name. Object Type: string "description" : "", #Event source description. Object Type: string @@ -764,6 +795,7 @@ def replace_event_sources_name_by_name(self, name="", body=({})): "vendor" : "", #Vendor name. Object Type: string "type" : "", #Event source type. Object Type: string "enable" : False, #Enable event source. Object Type: boolean + } """ url_path = "/event-sources/name/{name}" @@ -818,12 +850,14 @@ def new_extension_instance(self, body=({})): Required Body Parameters:['store_id'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "state" : "", #Desired state of the extension. Object Type: string "store_id" : "", #ID from the extension store. Object Type: string "files" : {}, #Maps extension file IDs to local content items, with ‘public:’ or ‘private:’ prefix. Object Type: object "ip_address" : "", #IP address to allocate to the extension, or null. Object Type: string "note" : "", #Note to be displayed with the extension.. Object Type: string + } """ url_path = "/extension/instance" @@ -852,9 +886,11 @@ def update_extension_instance_by_id(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "state" : "", #Desired state of the extension. Object Type: string "note" : "", #Note to be displayed with the extension.. Object Type: string + } """ url_path = "/extension/instance/{id}" @@ -902,7 +938,9 @@ def replace_extension_instance_by_id_config(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ + } """ url_path = "/extension/instance/{id}/config" @@ -951,10 +989,12 @@ def new_extension_instance_by_id_reinstall(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "state" : "", #Desired state of the extension. Object Type: string "files" : {}, #Maps extension file IDs to local content items, with ‘public:’ or ‘private:’ prefix. Object Type: object "ip_address" : "", #IP address to allocate to the extension, or null. Object Type: string + } """ url_path = "/extension/instance/{id}/reinstall" @@ -1026,11 +1066,13 @@ def new_extension_instance_by_id_upgrade(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "major" : False, #Indicated whether to install major extension upgrades. False by default.. Object Type: boolean "state" : "", #Desired state of the extension. Object Type: string "files" : {}, #Maps extension file IDs to local content items, with ‘public:’ or ‘private:’ prefix. Object Type: object "ip_address" : "", #IP address to allocate to the extension, or null. Object Type: string + } """ url_path = "/extension/instance/{id}/upgrade" @@ -1109,6 +1151,7 @@ def new_ingress_event_dictionary(self, body=({})): Required Body Parameters:['vendor', 'format_name', 'prefix', 'filter', 'fields', 'generic_fields'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor" : "", #Vendor of the ingress event. Object Type: string "format_name" : "", #Format Name of the ingress event. Object Type: string @@ -1127,6 +1170,7 @@ def new_ingress_event_dictionary(self, body=({})): "attr_name":"", #Ingress Event Generic Field attribute name. Object Type: string "generic_name":"", #Ingress Event Generic name of the attribute. Object Type: string }], #Generic Fields of the ingress event. Object Type: array + } """ url_path = "/ingress-event-dictionary" @@ -1159,6 +1203,7 @@ def update_ingress_event_dictionary_by_ingress_event_dictionary_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor" : "", #Vendor of the ingress event. Object Type: string "format_name" : "", #Format Name of the ingress event. Object Type: string @@ -1177,6 +1222,7 @@ def update_ingress_event_dictionary_by_ingress_event_dictionary_id( "attr_name":"", #Ingress Event Generic Field attribute name. Object Type: string "generic_name":"", #Ingress Event Generic name of the attribute. Object Type: string }], #Generic Fields of the ingress event. Object Type: array + } """ url_path = "/ingress-event-dictionary/{ingress_event_dictionary_id}" @@ -1198,6 +1244,7 @@ def replace_ingress_event_dictionary_by_ingress_event_dictionary_id( Required Body Parameters:['vendor', 'format_name', 'prefix', 'filter', 'fields', 'generic_fields'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor" : "", #Vendor of the ingress event. Object Type: string "format_name" : "", #Format Name of the ingress event. Object Type: string @@ -1216,6 +1263,7 @@ def replace_ingress_event_dictionary_by_ingress_event_dictionary_id( "attr_name":"", #Ingress Event Generic Field attribute name. Object Type: string "generic_name":"", #Ingress Event Generic name of the attribute. Object Type: string }], #Generic Fields of the ingress event. Object Type: array + } """ url_path = "/ingress-event-dictionary/{ingress_event_dictionary_id}" @@ -1263,6 +1311,7 @@ def update_ingress_event_dictionary_format_name_by_format_name( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor" : "", #Vendor of the ingress event. Object Type: string "format_name" : "", #Format Name of the ingress event. Object Type: string @@ -1281,6 +1330,7 @@ def update_ingress_event_dictionary_format_name_by_format_name( "attr_name":"", #Ingress Event Generic Field attribute name. Object Type: string "generic_name":"", #Ingress Event Generic name of the attribute. Object Type: string }], #Generic Fields of the ingress event. Object Type: array + } """ url_path = "/ingress-event-dictionary/format_name/{format_name}" @@ -1302,6 +1352,7 @@ def replace_ingress_event_dictionary_format_name_by_format_name( Required Body Parameters:['vendor', 'format_name', 'prefix', 'filter', 'fields', 'generic_fields'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor" : "", #Vendor of the ingress event. Object Type: string "format_name" : "", #Format Name of the ingress event. Object Type: string @@ -1320,6 +1371,7 @@ def replace_ingress_event_dictionary_format_name_by_format_name( "attr_name":"", #Ingress Event Generic Field attribute name. Object Type: string "generic_name":"", #Ingress Event Generic name of the attribute. Object Type: string }], #Generic Fields of the ingress event. Object Type: array + } """ url_path = "/ingress-event-dictionary/format_name/{format_name}" @@ -1376,6 +1428,7 @@ def new_syslog_export_filter(self, body=({})): Required Body Parameters:['name', 'export_template', 'export_event_format_type', 'syslog_servers'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of syslog export filter. Object Type: string "description" : "", #Description of syslog export filter. Object Type: string @@ -1390,6 +1443,7 @@ def new_syslog_export_filter(self, body=({})): "field_group_name" : "", #Field group name for syslog export filter. Object Type: string "custom_sql" : "", #Custom SQL for syslog export filter. Object Type: string "include_audit_data" : False, #null. Object Type: boolean + } """ url_path = "/syslog-export-filter" @@ -1422,6 +1476,7 @@ def update_syslog_export_filter_by_syslog_export_filter_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of syslog export filter. Object Type: string "description" : "", #Description of syslog export filter. Object Type: string @@ -1436,6 +1491,7 @@ def update_syslog_export_filter_by_syslog_export_filter_id( "field_group_name" : "", #Field group name for syslog export filter. Object Type: string "custom_sql" : "", #Custom SQL for syslog export filter. Object Type: string "include_audit_data" : False, #null. Object Type: boolean + } """ url_path = "/syslog-export-filter/{syslog_export_filter_id}" @@ -1457,6 +1513,7 @@ def replace_syslog_export_filter_by_syslog_export_filter_id( Required Body Parameters:['name', 'export_template', 'export_event_format_type', 'syslog_servers'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of syslog export filter. Object Type: string "description" : "", #Description of syslog export filter. Object Type: string @@ -1471,6 +1528,7 @@ def replace_syslog_export_filter_by_syslog_export_filter_id( "field_group_name" : "", #Field group name for syslog export filter. Object Type: string "custom_sql" : "", #Custom SQL for syslog export filter. Object Type: string "include_audit_data" : False, #null. Object Type: boolean + } """ url_path = "/syslog-export-filter/{syslog_export_filter_id}" @@ -1516,6 +1574,7 @@ def update_syslog_export_filter_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of syslog export filter. Object Type: string "description" : "", #Description of syslog export filter. Object Type: string @@ -1530,6 +1589,7 @@ def update_syslog_export_filter_name_by_name(self, name="", body=({})): "field_group_name" : "", #Field group name for syslog export filter. Object Type: string "custom_sql" : "", #Custom SQL for syslog export filter. Object Type: string "include_audit_data" : False, #null. Object Type: boolean + } """ url_path = "/syslog-export-filter/name/{name}" @@ -1549,6 +1609,7 @@ def replace_syslog_export_filter_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'export_template', 'export_event_format_type', 'syslog_servers'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of syslog export filter. Object Type: string "description" : "", #Description of syslog export filter. Object Type: string @@ -1563,6 +1624,7 @@ def replace_syslog_export_filter_name_by_name(self, name="", body=({})): "field_group_name" : "", #Field group name for syslog export filter. Object Type: string "custom_sql" : "", #Custom SQL for syslog export filter. Object Type: string "include_audit_data" : False, #null. Object Type: boolean + } """ url_path = "/syslog-export-filter/name/{name}" @@ -1617,11 +1679,13 @@ def new_syslog_target(self, body=({})): Required Body Parameters:['host_address', 'protocol', 'server_port'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of syslog target. Object Type: string "description" : "", #Description of syslog target. Object Type: string "server_port" : 0, #Server port of syslog target. Object Type: integer "protocol" : "", #Protocol used for syslog target. Object Type: string + } """ url_path = "/syslog-target" @@ -1650,11 +1714,13 @@ def update_syslog_target_by_syslog_target_id(self, syslog_target_id="", body=({} Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of syslog target. Object Type: string "description" : "", #Description of syslog target. Object Type: string "server_port" : 0, #Server port of syslog target. Object Type: integer "protocol" : "", #Protocol used for syslog target. Object Type: string + } """ url_path = "/syslog-target/{syslog_target_id}" @@ -1674,11 +1740,13 @@ def replace_syslog_target_by_syslog_target_id(self, syslog_target_id="", body=({ Required Body Parameters:['host_address', 'protocol', 'server_port'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of syslog target. Object Type: string "description" : "", #Description of syslog target. Object Type: string "server_port" : 0, #Server port of syslog target. Object Type: integer "protocol" : "", #Protocol used for syslog target. Object Type: string + } """ url_path = "/syslog-target/{syslog_target_id}" @@ -1724,11 +1792,13 @@ def update_syslog_target_host_address_by_host_address( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of syslog target. Object Type: string "description" : "", #Description of syslog target. Object Type: string "server_port" : 0, #Server port of syslog target. Object Type: integer "protocol" : "", #Protocol used for syslog target. Object Type: string + } """ url_path = "/syslog-target/host-address/{host_address}" @@ -1750,11 +1820,13 @@ def replace_syslog_target_host_address_by_host_address( Required Body Parameters:['host_address', 'protocol', 'server_port'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "host_address" : "", #Server host address of syslog target. Object Type: string "description" : "", #Description of syslog target. Object Type: string "server_port" : 0, #Server port of syslog target. Object Type: integer "protocol" : "", #Protocol used for syslog target. Object Type: string + } """ url_path = "/syslog-target/host-address/{host_address}" diff --git a/pyclearpass/api_localserverconfiguration.py b/pyclearpass/api_localserverconfiguration.py index c5a40cc..dd90b5f 100644 --- a/pyclearpass/api_localserverconfiguration.py +++ b/pyclearpass/api_localserverconfiguration.py @@ -48,9 +48,11 @@ def replace_server_access_control_by_server_uuid_resource_name( Required Body Parameters:['access', 'networks'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "access" : "", #Access type of the Access control application. Object Type: string "networks" : {}, #hostname, IP address or subnet (CIDR) of the Networks to be restricted (e.g. ["hostname.example.com", "1.2.3.4", "10.1.0.0/16"]). Object Type: object + } """ url_path = "/server/access-control/{server_uuid}/{resource_name}" @@ -113,12 +115,14 @@ def replace_ad_domain_join_by_server_uuid(self, server_uuid="", body=({})): Required Body Parameters:['domain_controller', 'netbios_name', 'on_name_conflict', 'username', 'password'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "domain_controller" : "", #FQDN of the domain controller. Object Type: string "netbios_name" : "", #NetBIOS name of the domain. Object Type: string "on_name_conflict" : 0, #Action to perform in case of a controller name conflict(1 - Use specified Domain Controller, 2 - Use Domain Controller returned by DNS query, 3 - Fail on conflict). Object Type: integer "username" : "", #Domain username . Object Type: string "password" : "", #Domain password. Object Type: string + } """ url_path = "/ad-domain/join/{server_uuid}" @@ -138,11 +142,13 @@ def replace_ad_domain_leave_by_server_uuid(self, server_uuid="", body=({})): Required Body Parameters:['netbios_name', 'username', 'password', 'force_leave'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "netbios_name" : "", #NetBIOS name of the domain. Object Type: string "username" : "", #Domain username . Object Type: string "password" : "", #Domain password. Object Type: string "force_leave" : False, #Leave domain even if AD is down. Object Type: boolean + } """ url_path = "/ad-domain/leave/{server_uuid}" @@ -164,9 +170,11 @@ def update_ad_domain_password_servers_by_server_uuid( Required Body Parameters:['netbios_name', 'password_servers'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "netbios_name" : "", #NetBIOS name of the domain. Object Type: string "password_servers" : {}, #List of Hostname or IP Address of the AD password servers. Object Type: object + } """ url_path = "/ad-domain/password-servers/{server_uuid}" @@ -216,8 +224,10 @@ def update_cluster_server_by_uuid(self, uuid="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ - "is_insight_enabled" : "" #variable unknown: , #True if this server has Insight reporting enabled. Object Type: bool + "is_insight_enabled" : {}, #True if this server has Insight reporting enabled. Object Type: bool + } """ url_path = "/cluster/server/{uuid}" @@ -259,6 +269,7 @@ def replace_server_snmp_by_server_uuid(self, server_uuid="", body=({})): Required Body Parameters:['engine_id', 'version'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "system_location" : "", #System location of the system monitoring settings for a server. Object Type: string "system_contact" : "", #System contact of the system monitoring settings for a server. Object Type: string @@ -271,6 +282,7 @@ def replace_server_snmp_by_server_uuid(self, server_uuid="", body=({})): "auth_key" : "", #Authentication key of system monitoring settings. Object Type: string "privacy_protocol" : "", #Privacy Protocol of system monitoring settings. Object Type: string "privacy_key" : "", #Privacy key of system monitoring settings. Object Type: string + } """ url_path = "/server/snmp/{server_uuid}" @@ -290,6 +302,7 @@ def update_server_snmp_by_server_uuid(self, server_uuid="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "system_location" : "", #System location of the system monitoring settings for a server. Object Type: string "system_contact" : "", #System contact of the system monitoring settings for a server. Object Type: string @@ -302,6 +315,7 @@ def update_server_snmp_by_server_uuid(self, server_uuid="", body=({})): "auth_key" : "", #Authentication key of system monitoring settings. Object Type: string "privacy_protocol" : "", #Privacy Protocol of system monitoring settings. Object Type: string "privacy_key" : "", #Privacy key of system monitoring settings. Object Type: string + } """ url_path = "/server/snmp/{server_uuid}" @@ -349,9 +363,11 @@ def update_service_parameter_by_server_uuid_service_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "param_name_1" : "", #param_value_1. Object Type: string "param_name_2" : "", #param_value_2.... Object Type: string + } """ url_path = "/service-parameter/{server_uuid}/{service_id}" diff --git a/pyclearpass/api_logs.py b/pyclearpass/api_logs.py index ed9312e..2910975 100644 --- a/pyclearpass/api_logs.py +++ b/pyclearpass/api_logs.py @@ -105,6 +105,7 @@ def new_system_event(self, body=({})): Required Body Parameters:['source', 'level', 'category', 'action', 'description', 'timestamp'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "source" : "", #Source. Object Type: string "level" : "", #Level. Object Type: string @@ -112,6 +113,7 @@ def new_system_event(self, body=({})): "action" : "", #Action. Object Type: string "description" : "", #Description. Object Type: string "timestamp" : "", #Timestamp. Object Type: string + } """ url_path = "/system-event" diff --git a/pyclearpass/api_platformcertificates.py b/pyclearpass/api_platformcertificates.py index 073ea72..d8d97c7 100644 --- a/pyclearpass/api_platformcertificates.py +++ b/pyclearpass/api_platformcertificates.py @@ -17,6 +17,7 @@ def new_cert_sign_request(self, body=({})): Required Body Parameters:['subject_CN', 'private_key_password', 'private_key_type', 'digest_algorithm'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "subject_CN" : "", #Common Name (CN). Object Type: string "subject_O" : "", #Organization (O). Object Type: string @@ -28,6 +29,7 @@ def new_cert_sign_request(self, body=({})): "private_key_password" : "", #Private Key Password. Object Type: string "private_key_type" : "", #null. Object Type: string "digest_algorithm" : "", #Digest Algorithm. Object Type: string + } """ url_path = "/cert-sign-request" @@ -67,10 +69,12 @@ def new_cert_trust_list(self, body=({})): Required Body Parameters:['cert_file', 'cert_usage'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "cert_file" : "", #Certificate trust list file. Object Type: string "enabled" : False, #Enable certificate trust list. Object Type: boolean "cert_usage" : False, #Usage of the certificate. Object Type: array + } """ url_path = "/cert-trust-list" @@ -101,10 +105,12 @@ def update_cert_trust_list_by_cert_trust_list_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "cert_file" : "", #Certificate trust list file. Object Type: string "enabled" : False, #Enable certificate trust list. Object Type: boolean "cert_usage" : False, #Usage of the certificate. Object Type: array + } """ url_path = "/cert-trust-list/{cert_trust_list_id}" @@ -197,10 +203,12 @@ def new_client_cert(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "certificate_url" : "", #Certificate File URL. Object Type: string "pkcs12_file_url" : "", #PKCS12 File URL. Object Type: string "pkcs12_passphrase" : "", #PKCS12 passphrase. Object Type: string + } """ url_path = "/client-cert" @@ -264,6 +272,7 @@ def new_revocation_list(self, body=({})): Required Body Parameters:['url'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "url" : "", #URL of the Certificate. Object Type: string "bypass_proxy" : False, #Bypass Proxy status of the Certificate. Object Type: boolean @@ -272,6 +281,7 @@ def new_revocation_list(self, body=({})): "last_update_status" : "", #Last updated status. Object Type: string "last_updated_time" : "", #Last updated time. Object Type: string "next_updated_time" : "", #Next update time. Object Type: string + } """ url_path = "/revocation-list" @@ -302,6 +312,7 @@ def update_revocation_list_by_revocation_list_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "url" : "", #URL of the Certificate. Object Type: string "bypass_proxy" : False, #Bypass Proxy status of the Certificate. Object Type: boolean @@ -310,6 +321,7 @@ def update_revocation_list_by_revocation_list_id( "last_update_status" : "", #Last updated status. Object Type: string "last_updated_time" : "", #Last updated time. Object Type: string "next_updated_time" : "", #Next update time. Object Type: string + } """ url_path = "/revocation-list/{revocation_list_id}" @@ -341,6 +353,7 @@ def new_self_signed_cert(self, body=({})): Required Body Parameters:['certificate_type', 'server', 'type', 'subject_CN', 'private_key_password', 'private_key_type', 'digest_algorithm'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "certificate_type" : "", #Certificate Type. Object Type: string "server" : "", #Server hostname. Object Type: string @@ -355,6 +368,7 @@ def new_self_signed_cert(self, body=({})): "private_key_password" : "", #Private Key Password. Object Type: string "private_key_type" : "", #Private Key Type. Object Type: string "digest_algorithm" : "", #Digest Algorithm. Object Type: string + } """ url_path = "/self-signed-cert" @@ -392,6 +406,7 @@ def update_server_cert_by_service_id(self, service_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "service_id" : 0, #Service ID of the server certificate(1-RADIUS server cert, 2-HTTPS(ECC) server cert, 7-HTTPS(RSA) server cert,21-RadSec server cert and 106-Database server cert). Object Type: integer "service_name" : "", #Service Name of the server certificate(RADIUS, HTTPS(ECC), HTTPS(RSA), RadSec or Database). Object Type: string @@ -409,6 +424,7 @@ def update_server_cert_by_service_id(self, service_id="", body=({})): "certificate_url" : "", #Certificate File URL. Object Type: string "pkcs12_file_url" : "", #PKCS12 File URL. Object Type: string "pkcs12_passphrase" : "", #PKCS12 passphrase. Object Type: string + } """ url_path = "/server-cert/{service_id}" @@ -446,10 +462,12 @@ def replace_server_cert_name_by_server_uuid_service_name( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "certificate_url" : "", #Certificate File URL. Object Type: string "pkcs12_file_url" : "", #PKCS12 File URL. Object Type: string "pkcs12_passphrase" : "", #PKCS12 passphrase. Object Type: string + } """ url_path = "/server-cert/name/{server_uuid}/{service_name}" @@ -522,10 +540,12 @@ def new_service_cert(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "certificate_url" : "", #Certificate File URL. Object Type: string "pkcs12_file_url" : "", #PKCS12 File URL. Object Type: string "pkcs12_passphrase" : "", #PKCS12 passphrase. Object Type: string + } """ url_path = "/service-cert" diff --git a/pyclearpass/api_policyelements.py b/pyclearpass/api_policyelements.py index 18d4a39..82d530b 100644 --- a/pyclearpass/api_policyelements.py +++ b/pyclearpass/api_policyelements.py @@ -40,6 +40,7 @@ def new_application_dictionary(self, body=({})): Required Body Parameters:['name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Application Dictionary. Object Type: string "description" : "", #Description of the Application Dictionary. Object Type: string @@ -48,6 +49,7 @@ def new_application_dictionary(self, body=({})): "attr_type":"", #Application Dictionary Attribute Type. Object Type: string "allowed_values":"", #Allowed Values for Application Dictionary Attributes in CSV format. Object Type: string }], #List of Application Dictionary Attributes. Object Type: array + } """ url_path = "/application-dictionary" @@ -80,6 +82,7 @@ def update_application_dictionary_by_application_dictionary_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Application Dictionary. Object Type: string "description" : "", #Description of the Application Dictionary. Object Type: string @@ -88,6 +91,7 @@ def update_application_dictionary_by_application_dictionary_id( "attr_type":"", #Application Dictionary Attribute Type. Object Type: string "allowed_values":"", #Allowed Values for Application Dictionary Attributes in CSV format. Object Type: string }], #List of Application Dictionary Attributes. Object Type: array + } """ url_path = "/application-dictionary/{application_dictionary_id}" @@ -109,6 +113,7 @@ def replace_application_dictionary_by_application_dictionary_id( Required Body Parameters:['name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Application Dictionary. Object Type: string "description" : "", #Description of the Application Dictionary. Object Type: string @@ -117,6 +122,7 @@ def replace_application_dictionary_by_application_dictionary_id( "attr_type":"", #Application Dictionary Attribute Type. Object Type: string "allowed_values":"", #Allowed Values for Application Dictionary Attributes in CSV format. Object Type: string }], #List of Application Dictionary Attributes. Object Type: array + } """ url_path = "/application-dictionary/{application_dictionary_id}" @@ -162,6 +168,7 @@ def update_application_dictionary_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Application Dictionary. Object Type: string "description" : "", #Description of the Application Dictionary. Object Type: string @@ -170,6 +177,7 @@ def update_application_dictionary_name_by_name(self, name="", body=({})): "attr_type":"", #Application Dictionary Attribute Type. Object Type: string "allowed_values":"", #Allowed Values for Application Dictionary Attributes in CSV format. Object Type: string }], #List of Application Dictionary Attributes. Object Type: array + } """ url_path = "/application-dictionary/name/{name}" @@ -189,6 +197,7 @@ def replace_application_dictionary_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Application Dictionary. Object Type: string "description" : "", #Description of the Application Dictionary. Object Type: string @@ -197,6 +206,7 @@ def replace_application_dictionary_name_by_name(self, name="", body=({})): "attr_type":"", #Application Dictionary Attribute Type. Object Type: string "allowed_values":"", #Allowed Values for Application Dictionary Attributes in CSV format. Object Type: string }], #List of Application Dictionary Attributes. Object Type: array + } """ url_path = "/application-dictionary/name/{name}" @@ -251,12 +261,14 @@ def new_auth_method(self, body=({})): Required Body Parameters:['name', 'method_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth method. Object Type: string "description" : "", #Description of the auth method. Object Type: string "method_type" : "", #Type of the auth method. Object Type: string - "details" : "" #variable unknown: , #Details JSON object of the auth method. Object Type: AuthMethodDetails - "inner_methods" : "" #variable unknown: , #List of inner methods of the auth method. Object Type: array + "details" : "", #Details JSON object of the auth method. Object Type: AuthMethodDetails + "inner_methods" : "", #List of inner methods of the auth method. Object Type: array + } """ url_path = "/auth-method" @@ -285,12 +297,14 @@ def update_auth_method_by_auth_method_id(self, auth_method_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth method. Object Type: string "description" : "", #Description of the auth method. Object Type: string "method_type" : "", #Type of the auth method. Object Type: string - "details" : "" #variable unknown: , #Details JSON object of the auth method. Object Type: AuthMethodDetails - "inner_methods" : "" #variable unknown: , #List of inner methods of the auth method. Object Type: array + "details" : "", #Details JSON object of the auth method. Object Type: AuthMethodDetails + "inner_methods" : "", #List of inner methods of the auth method. Object Type: array + } """ url_path = "/auth-method/{auth_method_id}" @@ -310,12 +324,14 @@ def replace_auth_method_by_auth_method_id(self, auth_method_id="", body=({})): Required Body Parameters:['name', 'method_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth method. Object Type: string "description" : "", #Description of the auth method. Object Type: string "method_type" : "", #Type of the auth method. Object Type: string - "details" : "" #variable unknown: , #Details JSON object of the auth method. Object Type: AuthMethodDetails - "inner_methods" : "" #variable unknown: , #List of inner methods of the auth method. Object Type: array + "details" : "", #Details JSON object of the auth method. Object Type: AuthMethodDetails + "inner_methods" : "", #List of inner methods of the auth method. Object Type: array + } """ url_path = "/auth-method/{auth_method_id}" @@ -359,12 +375,14 @@ def update_auth_method_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth method. Object Type: string "description" : "", #Description of the auth method. Object Type: string "method_type" : "", #Type of the auth method. Object Type: string - "details" : "" #variable unknown: , #Details JSON object of the auth method. Object Type: AuthMethodDetails - "inner_methods" : "" #variable unknown: , #List of inner methods of the auth method. Object Type: array + "details" : "", #Details JSON object of the auth method. Object Type: AuthMethodDetails + "inner_methods" : "", #List of inner methods of the auth method. Object Type: array + } """ url_path = "/auth-method/name/{name}" @@ -384,12 +402,14 @@ def replace_auth_method_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'method_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth method. Object Type: string "description" : "", #Description of the auth method. Object Type: string "method_type" : "", #Type of the auth method. Object Type: string - "details" : "" #variable unknown: , #Details JSON object of the auth method. Object Type: AuthMethodDetails - "inner_methods" : "" #variable unknown: , #List of inner methods of the auth method. Object Type: array + "details" : "", #Details JSON object of the auth method. Object Type: AuthMethodDetails + "inner_methods" : "", #List of inner methods of the auth method. Object Type: array + } """ url_path = "/auth-method/name/{name}" @@ -444,18 +464,20 @@ def new_auth_source(self, body=({})): Required Body Parameters:['name', 'type', 'cppm_primary_auth_source_connection_details', 'server_timeout', 'cache_timeout'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth source. Object Type: string "description" : "", #Description of the auth source. Object Type: string "type" : "", #Type of the auth source. Object Type: string "use_for_authorization" : False, #Enable to use this Authentication Source. Object Type: boolean "authorization_source_names" : False, #additional auth-sources from which role-mapping attributes to be fetched. Object Type: array - "cppm_primary_auth_source_connection_details" : "" #variable unknown: , #details of Authentication source. Object Type: AuthSourceConnectionDetailsMetadataCreate - "auth_source_radius_attributes" : "" #variable unknown: , #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsCreate - "cppm_auth_source_connection_backups" : "" #variable unknown: , #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataCreate - "auth_source_filters" : "" #variable unknown: , #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsCreate + "cppm_primary_auth_source_connection_details" : False, #details of Authentication source. Object Type: AuthSourceConnectionDetailsMetadataCreate + "auth_source_radius_attributes" : False, #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsCreate + "cppm_auth_source_connection_backups" : False, #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataCreate + "auth_source_filters" : False, #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsCreate "server_timeout" : 0, #Time out if the Authentication source fails to send a response to an authorization query. Object Type: integer "cache_timeout" : 0, #Specify the duration in number of seconds for which the attributes are cached.. Object Type: integer + } """ url_path = "/auth-source" @@ -484,18 +506,20 @@ def update_auth_source_by_auth_source_id(self, auth_source_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth source. Object Type: string "description" : "", #Description of the auth source. Object Type: string "type" : "", #Type of the auth source. Object Type: string "use_for_authorization" : False, #Enable to use this Authentication Source. Object Type: boolean "authorization_source_names" : False, #additional auth-sources from which role-mapping attributes to be fetched. Object Type: array - "cppm_primary_auth_source_connection_details" : "" #variable unknown: , #details of Authentication source. Object Type: AuthSourceConnectionDetailsUpdate - "auth_source_radius_attributes" : "" #variable unknown: , #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsUpdate - "cppm_auth_source_connection_backups" : "" #variable unknown: , #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataUpdate - "auth_source_filters" : "" #variable unknown: , #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsUpdate + "cppm_primary_auth_source_connection_details" : False, #details of Authentication source. Object Type: AuthSourceConnectionDetailsUpdate + "auth_source_radius_attributes" : False, #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsUpdate + "cppm_auth_source_connection_backups" : False, #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataUpdate + "auth_source_filters" : False, #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsUpdate "server_timeout" : 0, #Time out if the Authentication source fails to send a response to an authorization query. Object Type: integer "cache_timeout" : 0, #Specify the duration in number of seconds for which the attributes are cached.. Object Type: integer + } """ url_path = "/auth-source/{auth_source_id}" @@ -515,18 +539,20 @@ def replace_auth_source_by_auth_source_id(self, auth_source_id="", body=({})): Required Body Parameters:['name', 'type', 'cppm_primary_auth_source_connection_details', 'server_timeout', 'cache_timeout'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth source. Object Type: string "description" : "", #Description of the auth source. Object Type: string "type" : "", #Type of the auth source. Object Type: string "use_for_authorization" : False, #Enable to use this Authentication Source. Object Type: boolean "authorization_source_names" : False, #additional auth-sources from which role-mapping attributes to be fetched. Object Type: array - "cppm_primary_auth_source_connection_details" : "" #variable unknown: , #details of Authentication source. Object Type: AuthSourceConnectionDetailsMetadataReplace - "auth_source_radius_attributes" : "" #variable unknown: , #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsReplace - "cppm_auth_source_connection_backups" : "" #variable unknown: , #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataReplace - "auth_source_filters" : "" #variable unknown: , #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsReplace + "cppm_primary_auth_source_connection_details" : False, #details of Authentication source. Object Type: AuthSourceConnectionDetailsMetadataReplace + "auth_source_radius_attributes" : False, #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsReplace + "cppm_auth_source_connection_backups" : False, #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataReplace + "auth_source_filters" : False, #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsReplace "server_timeout" : 0, #Time out if the Authentication source fails to send a response to an authorization query. Object Type: integer "cache_timeout" : 0, #Specify the duration in number of seconds for which the attributes are cached.. Object Type: integer + } """ url_path = "/auth-source/{auth_source_id}" @@ -570,18 +596,20 @@ def update_auth_source_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth source. Object Type: string "description" : "", #Description of the auth source. Object Type: string "type" : "", #Type of the auth source. Object Type: string "use_for_authorization" : False, #Enable to use this Authentication Source. Object Type: boolean "authorization_source_names" : False, #additional auth-sources from which role-mapping attributes to be fetched. Object Type: array - "cppm_primary_auth_source_connection_details" : "" #variable unknown: , #details of Authentication source. Object Type: AuthSourceConnectionDetailsUpdate - "auth_source_radius_attributes" : "" #variable unknown: , #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsUpdate - "cppm_auth_source_connection_backups" : "" #variable unknown: , #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataUpdate - "auth_source_filters" : "" #variable unknown: , #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsUpdate + "cppm_primary_auth_source_connection_details" : False, #details of Authentication source. Object Type: AuthSourceConnectionDetailsUpdate + "auth_source_radius_attributes" : False, #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsUpdate + "cppm_auth_source_connection_backups" : False, #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataUpdate + "auth_source_filters" : False, #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsUpdate "server_timeout" : 0, #Time out if the Authentication source fails to send a response to an authorization query. Object Type: integer "cache_timeout" : 0, #Specify the duration in number of seconds for which the attributes are cached.. Object Type: integer + } """ url_path = "/auth-source/name/{name}" @@ -601,18 +629,20 @@ def replace_auth_source_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'type', 'cppm_primary_auth_source_connection_details', 'server_timeout', 'cache_timeout'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the auth source. Object Type: string "description" : "", #Description of the auth source. Object Type: string "type" : "", #Type of the auth source. Object Type: string "use_for_authorization" : False, #Enable to use this Authentication Source. Object Type: boolean "authorization_source_names" : False, #additional auth-sources from which role-mapping attributes to be fetched. Object Type: array - "cppm_primary_auth_source_connection_details" : "" #variable unknown: , #details of Authentication source. Object Type: AuthSourceConnectionDetailsMetadataReplace - "auth_source_radius_attributes" : "" #variable unknown: , #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsReplace - "cppm_auth_source_connection_backups" : "" #variable unknown: , #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataReplace - "auth_source_filters" : "" #variable unknown: , #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsReplace + "cppm_primary_auth_source_connection_details" : False, #details of Authentication source. Object Type: AuthSourceConnectionDetailsMetadataReplace + "auth_source_radius_attributes" : False, #details of authSourceRadiusAttributes. Object Type: AuthSourceRadiusAttributeDetailsReplace + "cppm_auth_source_connection_backups" : False, #details of authentication source backups. Object Type: AuthSourceBackupConnectionDetailsMetadataReplace + "auth_source_filters" : False, #details of auth_source_filters. Object Type: AuthSourceFiltersDetailsReplace "server_timeout" : 0, #Time out if the Authentication source fails to send a response to an authorization query. Object Type: integer "cache_timeout" : 0, #Specify the duration in number of seconds for which the attributes are cached.. Object Type: integer + } """ url_path = "/auth-source/name/{name}" @@ -667,13 +697,15 @@ def new_enforcement_policy(self, body=({})): Required Body Parameters:['name', 'enforcement_type', 'default_enforcement_profile', 'rule_eval_algo', 'rules'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Enforcement Policy. Object Type: string "description" : "", #Description of the Enforcement Policy. Object Type: string "enforcement_type" : "", #Enforcement Type of the Enforcement Policy. Object Type: string "default_enforcement_profile" : "", #Default Enforcement Profile for the Enforcement Policy. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm of the Enforcement Policy rules. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Enforcement Policy. Object Type: RulesSettingsCreate + "rules" : "", #List of Rules for Enforcement Policy. Object Type: RulesSettingsCreate + } """ url_path = "/enforcement-policy" @@ -704,13 +736,15 @@ def update_enforcement_policy_by_enforcement_policy_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Enforcement Policy. Object Type: string "description" : "", #Description of the Enforcement Policy. Object Type: string "enforcement_type" : "", #Enforcement Type of the Enforcement Policy. Object Type: string "default_enforcement_profile" : "", #Default Enforcement Profile for the Enforcement Policy. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm of the Enforcement Policy rules. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Enforcement Policy. Object Type: RulesSettingsUpdate + "rules" : "", #List of Rules for Enforcement Policy. Object Type: RulesSettingsUpdate + } """ url_path = "/enforcement-policy/{enforcement_policy_id}" @@ -732,13 +766,15 @@ def replace_enforcement_policy_by_enforcement_policy_id( Required Body Parameters:['name', 'enforcement_type', 'default_enforcement_profile', 'rule_eval_algo', 'rules'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Enforcement Policy. Object Type: string "description" : "", #Description of the Enforcement Policy. Object Type: string "enforcement_type" : "", #Enforcement Type of the Enforcement Policy. Object Type: string "default_enforcement_profile" : "", #Default Enforcement Profile for the Enforcement Policy. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm of the Enforcement Policy rules. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Enforcement Policy. Object Type: RulesSettingsReplace + "rules" : "", #List of Rules for Enforcement Policy. Object Type: RulesSettingsReplace + } """ url_path = "/enforcement-policy/{enforcement_policy_id}" @@ -784,13 +820,15 @@ def update_enforcement_policy_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Enforcement Policy. Object Type: string "description" : "", #Description of the Enforcement Policy. Object Type: string "enforcement_type" : "", #Enforcement Type of the Enforcement Policy. Object Type: string "default_enforcement_profile" : "", #Default Enforcement Profile for the Enforcement Policy. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm of the Enforcement Policy rules. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Enforcement Policy. Object Type: RulesSettingsUpdate + "rules" : "", #List of Rules for Enforcement Policy. Object Type: RulesSettingsUpdate + } """ url_path = "/enforcement-policy/name/{name}" @@ -810,13 +848,15 @@ def replace_enforcement_policy_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'enforcement_type', 'default_enforcement_profile', 'rule_eval_algo', 'rules'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Enforcement Policy. Object Type: string "description" : "", #Description of the Enforcement Policy. Object Type: string "enforcement_type" : "", #Enforcement Type of the Enforcement Policy. Object Type: string "default_enforcement_profile" : "", #Default Enforcement Profile for the Enforcement Policy. Object Type: string "rule_eval_algo" : "", #Rule Evaluation Algorithm of the Enforcement Policy rules. Object Type: string - "rules" : "" #variable unknown: , #List of Rules for Enforcement Policy. Object Type: RulesSettingsReplace + "rules" : "", #List of Rules for Enforcement Policy. Object Type: RulesSettingsReplace + } """ url_path = "/enforcement-policy/name/{name}" @@ -871,6 +911,7 @@ def new_network_device(self, body=({})): Required Body Parameters:['name', 'ip_address'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "description" : "", #Description of the network device. Object Type: string "name" : "", #Name of the network device. Object Type: string @@ -882,12 +923,13 @@ def new_network_device(self, body=({})): "coa_capable" : False, #Flag indicating if the network device is capable of CoA. Object Type: boolean "coa_port" : 0, #CoA port number of the network device. Object Type: integer "radsec_enabled" : False, #Flag indicating if the network device is radSec enabled. Object Type: boolean - "snmp_read" : "" #variable unknown: , #SNMP read settings of the network device. Object Type: SNMPReadSettings - "snmp_write" : "" #variable unknown: , #SNMP write settings of the network device. Object Type: SNMPWriteSettings - "radsec_config" : "" #variable unknown: , #RadSec settings of the network device. Object Type: RadSecSettings - "cli_config" : "" #variable unknown: , #CLI Configuration details of the network device. Object Type: CLISettings - "onConnect_enforcement" : "" #variable unknown: , #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings + "snmp_read" : False, #SNMP read settings of the network device. Object Type: SNMPReadSettings + "snmp_write" : False, #SNMP write settings of the network device. Object Type: SNMPWriteSettings + "radsec_config" : False, #RadSec settings of the network device. Object Type: RadSecSettings + "cli_config" : False, #CLI Configuration details of the network device. Object Type: CLISettings + "onConnect_enforcement" : False, #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the network device. Object Type: object + } """ url_path = "/network-device" @@ -918,6 +960,7 @@ def update_network_device_by_network_device_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "description" : "", #Description of the network device. Object Type: string "name" : "", #Name of the network device. Object Type: string @@ -929,12 +972,13 @@ def update_network_device_by_network_device_id( "coa_capable" : False, #Flag indicating if the network device is capable of CoA. Object Type: boolean "coa_port" : 0, #CoA port number of the network device. Object Type: integer "radsec_enabled" : False, #Flag indicating if the network device is radSec enabled. Object Type: boolean - "snmp_read" : "" #variable unknown: , #SNMP read settings of the network device. Object Type: SNMPReadSettings - "snmp_write" : "" #variable unknown: , #SNMP write settings of the network device. Object Type: SNMPWriteSettings - "radsec_config" : "" #variable unknown: , #RadSec settings of the network device. Object Type: RadSecSettings - "cli_config" : "" #variable unknown: , #CLI Configuration details of the network device. Object Type: CLISettings - "onConnect_enforcement" : "" #variable unknown: , #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings + "snmp_read" : False, #SNMP read settings of the network device. Object Type: SNMPReadSettings + "snmp_write" : False, #SNMP write settings of the network device. Object Type: SNMPWriteSettings + "radsec_config" : False, #RadSec settings of the network device. Object Type: RadSecSettings + "cli_config" : False, #CLI Configuration details of the network device. Object Type: CLISettings + "onConnect_enforcement" : False, #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the network device. Object Type: object + } """ url_path = "/network-device/{network_device_id}" @@ -956,6 +1000,7 @@ def replace_network_device_by_network_device_id( Required Body Parameters:['name', 'ip_address'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "description" : "", #Description of the network device. Object Type: string "name" : "", #Name of the network device. Object Type: string @@ -967,12 +1012,13 @@ def replace_network_device_by_network_device_id( "coa_capable" : False, #Flag indicating if the network device is capable of CoA. Object Type: boolean "coa_port" : 0, #CoA port number of the network device. Object Type: integer "radsec_enabled" : False, #Flag indicating if the network device is radSec enabled. Object Type: boolean - "snmp_read" : "" #variable unknown: , #SNMP read settings of the network device. Object Type: SNMPReadSettings - "snmp_write" : "" #variable unknown: , #SNMP write settings of the network device. Object Type: SNMPWriteSettings - "radsec_config" : "" #variable unknown: , #RadSec settings of the network device. Object Type: RadSecSettings - "cli_config" : "" #variable unknown: , #CLI Configuration details of the network device. Object Type: CLISettings - "onConnect_enforcement" : "" #variable unknown: , #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings + "snmp_read" : False, #SNMP read settings of the network device. Object Type: SNMPReadSettings + "snmp_write" : False, #SNMP write settings of the network device. Object Type: SNMPWriteSettings + "radsec_config" : False, #RadSec settings of the network device. Object Type: RadSecSettings + "cli_config" : False, #CLI Configuration details of the network device. Object Type: CLISettings + "onConnect_enforcement" : False, #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the network device. Object Type: object + } """ url_path = "/network-device/{network_device_id}" @@ -1016,6 +1062,7 @@ def update_network_device_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "description" : "", #Description of the network device. Object Type: string "name" : "", #Name of the network device. Object Type: string @@ -1027,12 +1074,13 @@ def update_network_device_name_by_name(self, name="", body=({})): "coa_capable" : False, #Flag indicating if the network device is capable of CoA. Object Type: boolean "coa_port" : 0, #CoA port number of the network device. Object Type: integer "radsec_enabled" : False, #Flag indicating if the network device is radSec enabled. Object Type: boolean - "snmp_read" : "" #variable unknown: , #SNMP read settings of the network device. Object Type: SNMPReadSettings - "snmp_write" : "" #variable unknown: , #SNMP write settings of the network device. Object Type: SNMPWriteSettings - "radsec_config" : "" #variable unknown: , #RadSec settings of the network device. Object Type: RadSecSettings - "cli_config" : "" #variable unknown: , #CLI Configuration details of the network device. Object Type: CLISettings - "onConnect_enforcement" : "" #variable unknown: , #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings + "snmp_read" : False, #SNMP read settings of the network device. Object Type: SNMPReadSettings + "snmp_write" : False, #SNMP write settings of the network device. Object Type: SNMPWriteSettings + "radsec_config" : False, #RadSec settings of the network device. Object Type: RadSecSettings + "cli_config" : False, #CLI Configuration details of the network device. Object Type: CLISettings + "onConnect_enforcement" : False, #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the network device. Object Type: object + } """ url_path = "/network-device/name/{name}" @@ -1052,6 +1100,7 @@ def replace_network_device_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'ip_address'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "description" : "", #Description of the network device. Object Type: string "name" : "", #Name of the network device. Object Type: string @@ -1063,12 +1112,13 @@ def replace_network_device_name_by_name(self, name="", body=({})): "coa_capable" : False, #Flag indicating if the network device is capable of CoA. Object Type: boolean "coa_port" : 0, #CoA port number of the network device. Object Type: integer "radsec_enabled" : False, #Flag indicating if the network device is radSec enabled. Object Type: boolean - "snmp_read" : "" #variable unknown: , #SNMP read settings of the network device. Object Type: SNMPReadSettings - "snmp_write" : "" #variable unknown: , #SNMP write settings of the network device. Object Type: SNMPWriteSettings - "radsec_config" : "" #variable unknown: , #RadSec settings of the network device. Object Type: RadSecSettings - "cli_config" : "" #variable unknown: , #CLI Configuration details of the network device. Object Type: CLISettings - "onConnect_enforcement" : "" #variable unknown: , #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings + "snmp_read" : False, #SNMP read settings of the network device. Object Type: SNMPReadSettings + "snmp_write" : False, #SNMP write settings of the network device. Object Type: SNMPWriteSettings + "radsec_config" : False, #RadSec settings of the network device. Object Type: RadSecSettings + "cli_config" : False, #CLI Configuration details of the network device. Object Type: CLISettings + "onConnect_enforcement" : False, #OnConnect Enforcement settings of the network device. Object Type: OnConnectEnforcementSettings "attributes" : {}, #Additional attributes(key/value pairs) may be stored with the network device. Object Type: object + } """ url_path = "/network-device/name/{name}" @@ -1123,11 +1173,13 @@ def new_network_device_group(self, body=({})): Required Body Parameters:['name', 'group_format', 'value'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the network device group. Object Type: string "description" : "", #Description of the network device group. Object Type: string "group_format" : "", #Format of the network devices. Object Type: string "value" : "", #Network devices in the specified format. Object Type: string + } """ url_path = "/network-device-group" @@ -1160,11 +1212,13 @@ def update_network_device_group_by_network_device_group_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the network device group. Object Type: string "description" : "", #Description of the network device group. Object Type: string "group_format" : "", #Format of the network devices. Object Type: string "value" : "", #Network devices in the specified format. Object Type: string + } """ url_path = "/network-device-group/{network_device_group_id}" @@ -1186,11 +1240,13 @@ def replace_network_device_group_by_network_device_group_id( Required Body Parameters:['name', 'group_format', 'value'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the network device group. Object Type: string "description" : "", #Description of the network device group. Object Type: string "group_format" : "", #Format of the network devices. Object Type: string "value" : "", #Network devices in the specified format. Object Type: string + } """ url_path = "/network-device-group/{network_device_group_id}" @@ -1236,11 +1292,13 @@ def update_network_device_group_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the network device group. Object Type: string "description" : "", #Description of the network device group. Object Type: string "group_format" : "", #Format of the network devices. Object Type: string "value" : "", #Network devices in the specified format. Object Type: string + } """ url_path = "/network-device-group/name/{name}" @@ -1260,11 +1318,13 @@ def replace_network_device_group_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'group_format', 'value'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the network device group. Object Type: string "description" : "", #Description of the network device group. Object Type: string "group_format" : "", #Format of the network devices. Object Type: string "value" : "", #Network devices in the specified format. Object Type: string + } """ url_path = "/network-device-group/name/{name}" @@ -1319,6 +1379,7 @@ def new_posture_policy(self, body=({})): Required Body Parameters:['name', 'posture_agent', 'policy_xml'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Posture Policy Name. Object Type: string "description" : "", #Description. Object Type: string @@ -1327,6 +1388,7 @@ def new_posture_policy(self, body=({})): "plugin_version" : "", #Plugin Version. Object Type: string "roles" : "", #Restrict by Roles. Object Type: array "policy_xml" : "", #Posture Policy XML. Object Type: string + } """ url_path = "/posture-policy" @@ -1357,6 +1419,7 @@ def update_posture_policy_by_posture_policy_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Posture Policy Name. Object Type: string "description" : "", #Description. Object Type: string @@ -1365,6 +1428,7 @@ def update_posture_policy_by_posture_policy_id( "plugin_version" : "", #Plugin Version. Object Type: string "roles" : "", #Restrict by Roles. Object Type: array "policy_xml" : "", #Posture Policy XML. Object Type: string + } """ url_path = "/posture-policy/{posture_policy_id}" @@ -1386,6 +1450,7 @@ def replace_posture_policy_by_posture_policy_id( Required Body Parameters:['name', 'posture_agent', 'policy_xml'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Posture Policy Name. Object Type: string "description" : "", #Description. Object Type: string @@ -1394,6 +1459,7 @@ def replace_posture_policy_by_posture_policy_id( "plugin_version" : "", #Plugin Version. Object Type: string "roles" : "", #Restrict by Roles. Object Type: array "policy_xml" : "", #Posture Policy XML. Object Type: string + } """ url_path = "/posture-policy/{posture_policy_id}" @@ -1437,6 +1503,7 @@ def update_posture_policy_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Posture Policy Name. Object Type: string "description" : "", #Description. Object Type: string @@ -1445,6 +1512,7 @@ def update_posture_policy_name_by_name(self, name="", body=({})): "plugin_version" : "", #Plugin Version. Object Type: string "roles" : "", #Restrict by Roles. Object Type: array "policy_xml" : "", #Posture Policy XML. Object Type: string + } """ url_path = "/posture-policy/name/{name}" @@ -1464,6 +1532,7 @@ def replace_posture_policy_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'posture_agent', 'policy_xml'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Posture Policy Name. Object Type: string "description" : "", #Description. Object Type: string @@ -1472,6 +1541,7 @@ def replace_posture_policy_name_by_name(self, name="", body=({})): "plugin_version" : "", #Plugin Version. Object Type: string "roles" : "", #Restrict by Roles. Object Type: array "policy_xml" : "", #Posture Policy XML. Object Type: string + } """ url_path = "/posture-policy/name/{name}" @@ -1526,6 +1596,7 @@ def new_radius_dictionary(self, body=({})): Required Body Parameters:['vendor_id', 'vendor_name', 'prefix', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_id" : 0, #Vendor ID of RADIUS Dictionary. Object Type: integer "vendor_name" : "", #Vendor Name of RADIUS Dictionary. Object Type: string @@ -1539,6 +1610,7 @@ def new_radius_dictionary(self, body=({})): "extra_data":"", #RADIUS Dictionary Attribute Extra Data. Object Type: string "valid_values":[{"":""}], #RADIUS Dictionary Attribute Valid Values. Object Type: array }], #Attributes of RADIUS Dictionary. Object Type: array + } """ url_path = "/radius-dictionary" @@ -1569,6 +1641,7 @@ def update_radius_dictionary_by_radius_dictionary_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_id" : 0, #Vendor ID of RADIUS Dictionary. Object Type: integer "vendor_name" : "", #Vendor Name of RADIUS Dictionary. Object Type: string @@ -1582,6 +1655,7 @@ def update_radius_dictionary_by_radius_dictionary_id( "extra_data":"", #RADIUS Dictionary Attribute Extra Data. Object Type: string "valid_values":[{"":""}], #RADIUS Dictionary Attribute Valid Values. Object Type: array }], #Attributes of RADIUS Dictionary. Object Type: array + } """ url_path = "/radius-dictionary/{radius_dictionary_id}" @@ -1603,6 +1677,7 @@ def replace_radius_dictionary_by_radius_dictionary_id( Required Body Parameters:['vendor_id', 'vendor_name', 'prefix', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_id" : 0, #Vendor ID of RADIUS Dictionary. Object Type: integer "vendor_name" : "", #Vendor Name of RADIUS Dictionary. Object Type: string @@ -1616,6 +1691,7 @@ def replace_radius_dictionary_by_radius_dictionary_id( "extra_data":"", #RADIUS Dictionary Attribute Extra Data. Object Type: string "valid_values":[{"":""}], #RADIUS Dictionary Attribute Valid Values. Object Type: array }], #Attributes of RADIUS Dictionary. Object Type: array + } """ url_path = "/radius-dictionary/{radius_dictionary_id}" @@ -1647,6 +1723,7 @@ def update_radius_dictionary_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_id" : 0, #Vendor ID of RADIUS Dictionary. Object Type: integer "vendor_name" : "", #Vendor Name of RADIUS Dictionary. Object Type: string @@ -1660,6 +1737,7 @@ def update_radius_dictionary_name_by_name(self, name="", body=({})): "extra_data":"", #RADIUS Dictionary Attribute Extra Data. Object Type: string "valid_values":[{"":""}], #RADIUS Dictionary Attribute Valid Values. Object Type: array }], #Attributes of RADIUS Dictionary. Object Type: array + } """ url_path = "/radius-dictionary/name/{name}" @@ -1679,6 +1757,7 @@ def replace_radius_dictionary_name_by_name(self, name="", body=({})): Required Body Parameters:['vendor_id', 'vendor_name', 'prefix', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_id" : 0, #Vendor ID of RADIUS Dictionary. Object Type: integer "vendor_name" : "", #Vendor Name of RADIUS Dictionary. Object Type: string @@ -1692,6 +1771,7 @@ def replace_radius_dictionary_name_by_name(self, name="", body=({})): "extra_data":"", #RADIUS Dictionary Attribute Extra Data. Object Type: string "valid_values":[{"":""}], #RADIUS Dictionary Attribute Valid Values. Object Type: array }], #Attributes of RADIUS Dictionary. Object Type: array + } """ url_path = "/radius-dictionary/name/{name}" @@ -1786,6 +1866,7 @@ def new_radius_dynamic_authorization_template(self, body=({})): Required Body Parameters:['name', 'vendor_name', 'template_type', 'display_name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_name" : "", #Vendor Name of RADIUS Dynamic Authorization Template. Object Type: string "template_type" : "", #Template Type of RADIUS Dynamic Authorization Template. Object Type: string @@ -1797,6 +1878,7 @@ def new_radius_dynamic_authorization_template(self, body=({})): "name":"", #RADIUS Dynamic Authorization Template Attribute Name. Object Type: string "type":"", #RADIUS Dynamic Authorization Template Attribute Type. Object Type: string }], #Attributes of RADIUS Dynamic Authorization Template. Object Type: array + } """ url_path = "/radius-dynamic-authorization-template" @@ -1831,6 +1913,7 @@ def update_radius_dynamic_authorization_template_by_radius_dynamic_authorization Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_name" : "", #Vendor Name of RADIUS Dynamic Authorization Template. Object Type: string "template_type" : "", #Template Type of RADIUS Dynamic Authorization Template. Object Type: string @@ -1842,6 +1925,7 @@ def update_radius_dynamic_authorization_template_by_radius_dynamic_authorization "name":"", #RADIUS Dynamic Authorization Template Attribute Name. Object Type: string "type":"", #RADIUS Dynamic Authorization Template Attribute Type. Object Type: string }], #Attributes of RADIUS Dynamic Authorization Template. Object Type: array + } """ url_path = "/radius-dynamic-authorization-template/{radius_dynamic_authorization_template_id}" @@ -1865,6 +1949,7 @@ def replace_radius_dynamic_authorization_template_by_radius_dynamic_authorizatio Required Body Parameters:['name', 'vendor_name', 'template_type', 'display_name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_name" : "", #Vendor Name of RADIUS Dynamic Authorization Template. Object Type: string "template_type" : "", #Template Type of RADIUS Dynamic Authorization Template. Object Type: string @@ -1876,6 +1961,7 @@ def replace_radius_dynamic_authorization_template_by_radius_dynamic_authorizatio "name":"", #RADIUS Dynamic Authorization Template Attribute Name. Object Type: string "type":"", #RADIUS Dynamic Authorization Template Attribute Type. Object Type: string }], #Attributes of RADIUS Dynamic Authorization Template. Object Type: array + } """ url_path = "/radius-dynamic-authorization-template/{radius_dynamic_authorization_template_id}" @@ -1927,6 +2013,7 @@ def update_radius_dynamic_authorization_template_name_by_name( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_name" : "", #Vendor Name of RADIUS Dynamic Authorization Template. Object Type: string "template_type" : "", #Template Type of RADIUS Dynamic Authorization Template. Object Type: string @@ -1938,6 +2025,7 @@ def update_radius_dynamic_authorization_template_name_by_name( "name":"", #RADIUS Dynamic Authorization Template Attribute Name. Object Type: string "type":"", #RADIUS Dynamic Authorization Template Attribute Type. Object Type: string }], #Attributes of RADIUS Dynamic Authorization Template. Object Type: array + } """ url_path = "/radius-dynamic-authorization-template/name/{name}" @@ -1959,6 +2047,7 @@ def replace_radius_dynamic_authorization_template_name_by_name( Required Body Parameters:['name', 'vendor_name', 'template_type', 'display_name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "vendor_name" : "", #Vendor Name of RADIUS Dynamic Authorization Template. Object Type: string "template_type" : "", #Template Type of RADIUS Dynamic Authorization Template. Object Type: string @@ -1970,6 +2059,7 @@ def replace_radius_dynamic_authorization_template_name_by_name( "name":"", #RADIUS Dynamic Authorization Template Attribute Name. Object Type: string "type":"", #RADIUS Dynamic Authorization Template Attribute Type. Object Type: string }], #Attributes of RADIUS Dynamic Authorization Template. Object Type: array + } """ url_path = "/radius-dynamic-authorization-template/name/{name}" @@ -2024,6 +2114,7 @@ def new_proxy_target(self, body=({})): Required Body Parameters:['name', 'host_name', 'proxy_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the proxy target. Object Type: string "host_name" : "", #Host name of the proxy target. Object Type: string @@ -2036,6 +2127,7 @@ def new_proxy_target(self, body=({})): "radsec_verify_cert" : False, #Enable to verify the server certificate. Object Type: boolean "cert_subject" : "", #Client Certificate Subject. Object Type: string "enable_status_server_msgs" : False, #Enable to send the status-server message. Object Type: boolean + } """ url_path = "/proxy-target" @@ -2064,6 +2156,7 @@ def update_proxy_target_by_proxy_target_id(self, proxy_target_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the proxy target. Object Type: string "host_name" : "", #Host name of the proxy target. Object Type: string @@ -2076,6 +2169,7 @@ def update_proxy_target_by_proxy_target_id(self, proxy_target_id="", body=({})): "radsec_verify_cert" : False, #Enable to verify the server certificate. Object Type: boolean "cert_subject" : "", #Client Certificate Subject. Object Type: string "enable_status_server_msgs" : False, #Enable to send the status-server message. Object Type: boolean + } """ url_path = "/proxy-target/{proxy_target_id}" @@ -2095,6 +2189,7 @@ def replace_proxy_target_by_proxy_target_id(self, proxy_target_id="", body=({})) Required Body Parameters:['name', 'host_name', 'proxy_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the proxy target. Object Type: string "host_name" : "", #Host name of the proxy target. Object Type: string @@ -2107,6 +2202,7 @@ def replace_proxy_target_by_proxy_target_id(self, proxy_target_id="", body=({})) "radsec_verify_cert" : False, #Enable to verify the server certificate. Object Type: boolean "cert_subject" : "", #Client Certificate Subject. Object Type: string "enable_status_server_msgs" : False, #Enable to send the status-server message. Object Type: boolean + } """ url_path = "/proxy-target/{proxy_target_id}" @@ -2150,6 +2246,7 @@ def update_proxy_target_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the proxy target. Object Type: string "host_name" : "", #Host name of the proxy target. Object Type: string @@ -2162,6 +2259,7 @@ def update_proxy_target_name_by_name(self, name="", body=({})): "radsec_verify_cert" : False, #Enable to verify the server certificate. Object Type: boolean "cert_subject" : "", #Client Certificate Subject. Object Type: string "enable_status_server_msgs" : False, #Enable to send the status-server message. Object Type: boolean + } """ url_path = "/proxy-target/name/{name}" @@ -2181,6 +2279,7 @@ def replace_proxy_target_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'host_name', 'proxy_type'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the proxy target. Object Type: string "host_name" : "", #Host name of the proxy target. Object Type: string @@ -2193,6 +2292,7 @@ def replace_proxy_target_name_by_name(self, name="", body=({})): "radsec_verify_cert" : False, #Enable to verify the server certificate. Object Type: boolean "cert_subject" : "", #Client Certificate Subject. Object Type: string "enable_status_server_msgs" : False, #Enable to send the status-server message. Object Type: boolean + } """ url_path = "/proxy-target/name/{name}" @@ -2245,9 +2345,11 @@ def new_role(self, body=({})): Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the role. Object Type: string "description" : "", #Description of the role. Object Type: string + } """ url_path = "/role" @@ -2276,9 +2378,11 @@ def update_role_by_role_id(self, role_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the role. Object Type: string "description" : "", #Description of the role. Object Type: string + } """ url_path = "/role/{role_id}" @@ -2298,9 +2402,11 @@ def replace_role_by_role_id(self, role_id="", body=({})): Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the role. Object Type: string "description" : "", #Description of the role. Object Type: string + } """ url_path = "/role/{role_id}" @@ -2344,9 +2450,11 @@ def update_role_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the role. Object Type: string "description" : "", #Description of the role. Object Type: string + } """ url_path = "/role/name/{name}" @@ -2366,9 +2474,11 @@ def replace_role_name_by_name(self, name="", body=({})): Required Body Parameters:['name'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the role. Object Type: string "description" : "", #Description of the role. Object Type: string + } """ url_path = "/role/name/{name}" @@ -2423,12 +2533,14 @@ def new_role_mapping(self, body=({})): Required Body Parameters:['name', 'default_role_name', 'rule_combine_algo', 'rules'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Role mapping policy name. Object Type: string "description" : "", #Role mapping description. Object Type: string "default_role_name" : "", #Role mapping default role name. Object Type: string "rule_combine_algo" : "", #Role mapping rules evaluation algorithm. Object Type: string - "rules" : "" #variable unknown: , #List of role mapping rules. Object Type: RulesSettingsCreate + "rules" : "", #List of role mapping rules. Object Type: RulesSettingsCreate + } """ url_path = "/role-mapping" @@ -2457,12 +2569,14 @@ def update_role_mapping_by_role_mapping_id(self, role_mapping_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Role mapping policy name. Object Type: string "description" : "", #Role mapping description. Object Type: string "default_role_name" : "", #Role mapping default role name. Object Type: string "rule_combine_algo" : "", #Role mapping rules evaluation algorithm. Object Type: string - "rules" : "" #variable unknown: , #List of role mapping rules. Object Type: RulesSettingsUpdate + "rules" : "", #List of role mapping rules. Object Type: RulesSettingsUpdate + } """ url_path = "/role-mapping/{role_mapping_id}" @@ -2482,12 +2596,14 @@ def replace_role_mapping_by_role_mapping_id(self, role_mapping_id="", body=({})) Required Body Parameters:['name', 'default_role_name', 'rule_combine_algo', 'rules'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Role mapping policy name. Object Type: string "description" : "", #Role mapping description. Object Type: string "default_role_name" : "", #Role mapping default role name. Object Type: string "rule_combine_algo" : "", #Role mapping rules evaluation algorithm. Object Type: string - "rules" : "" #variable unknown: , #List of role mapping rules. Object Type: RulesSettingsReplace + "rules" : "", #List of role mapping rules. Object Type: RulesSettingsReplace + } """ url_path = "/role-mapping/{role_mapping_id}" @@ -2531,12 +2647,14 @@ def update_role_mapping_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Role mapping policy name. Object Type: string "description" : "", #Role mapping description. Object Type: string "default_role_name" : "", #Role mapping default role name. Object Type: string "rule_combine_algo" : "", #Role mapping rules evaluation algorithm. Object Type: string - "rules" : "" #variable unknown: , #List of role mapping rules. Object Type: RulesSettingsUpdate + "rules" : "", #List of role mapping rules. Object Type: RulesSettingsUpdate + } """ url_path = "/role-mapping/name/{name}" @@ -2556,12 +2674,14 @@ def replace_role_mapping_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'default_role_name', 'rule_combine_algo', 'rules'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Role mapping policy name. Object Type: string "description" : "", #Role mapping description. Object Type: string "default_role_name" : "", #Role mapping default role name. Object Type: string "rule_combine_algo" : "", #Role mapping rules evaluation algorithm. Object Type: string - "rules" : "" #variable unknown: , #List of role mapping rules. Object Type: RulesSettingsReplace + "rules" : "", #List of role mapping rules. Object Type: RulesSettingsReplace + } """ url_path = "/role-mapping/name/{name}" @@ -2616,6 +2736,7 @@ def new_config_service(self, body=({})): Required Body Parameters:['name', 'template', 'enf_policy'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Service. Object Type: string "template" : "", #Template of the Service. Object Type: string @@ -2682,6 +2803,7 @@ def new_config_service(self, body=({})): "name":"", #Name. Object Type: string }], #RADIUS attributes to be removed from remote server (proxy target) reply. Object Type: array "radius_proxy_enable_for_acct" : False, #Enable proxy for accounting requests (Applicable only for RADIUS Proxy Service Type) . Object Type: boolean + } """ url_path = "/config/service" @@ -2710,6 +2832,7 @@ def update_config_service_by_services_id(self, services_id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Service. Object Type: string "template" : "", #Template of the Service. Object Type: string @@ -2776,6 +2899,7 @@ def update_config_service_by_services_id(self, services_id="", body=({})): "name":"", #Name. Object Type: string }], #RADIUS attributes to be removed from remote server (proxy target) reply. Object Type: array "radius_proxy_enable_for_acct" : False, #Enable proxy for accounting requests (Applicable only for RADIUS Proxy Service Type) . Object Type: boolean + } """ url_path = "/config/service/{services_id}" @@ -2795,6 +2919,7 @@ def replace_config_service_by_services_id(self, services_id="", body=({})): Required Body Parameters:['name', 'template', 'enf_policy'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Service. Object Type: string "template" : "", #Template of the Service. Object Type: string @@ -2861,6 +2986,7 @@ def replace_config_service_by_services_id(self, services_id="", body=({})): "name":"", #Name. Object Type: string }], #RADIUS attributes to be removed from remote server (proxy target) reply. Object Type: array "radius_proxy_enable_for_acct" : False, #Enable proxy for accounting requests (Applicable only for RADIUS Proxy Service Type) . Object Type: boolean + } """ url_path = "/config/service/{services_id}" @@ -2904,6 +3030,7 @@ def update_config_service_name_by_services_name(self, services_name="", body=({} Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Service. Object Type: string "template" : "", #Template of the Service. Object Type: string @@ -2970,6 +3097,7 @@ def update_config_service_name_by_services_name(self, services_name="", body=({} "name":"", #Name. Object Type: string }], #RADIUS attributes to be removed from remote server (proxy target) reply. Object Type: array "radius_proxy_enable_for_acct" : False, #Enable proxy for accounting requests (Applicable only for RADIUS Proxy Service Type) . Object Type: boolean + } """ url_path = "/config/service/name/{services_name}" @@ -2989,6 +3117,7 @@ def replace_config_service_name_by_services_name(self, services_name="", body=({ Required Body Parameters:['name', 'template', 'enf_policy'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of the Service. Object Type: string "template" : "", #Template of the Service. Object Type: string @@ -3055,6 +3184,7 @@ def replace_config_service_name_by_services_name(self, services_name="", body=({ "name":"", #Name. Object Type: string }], #RADIUS attributes to be removed from remote server (proxy target) reply. Object Type: array "radius_proxy_enable_for_acct" : False, #Enable proxy for accounting requests (Applicable only for RADIUS Proxy Service Type) . Object Type: boolean + } """ url_path = "/config/service/name/{services_name}" @@ -3133,11 +3263,13 @@ def update_config_service_reorder(self, body=({})): Required Body Parameters:['service_orders'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "service_orders" : [{ "service_name":"", #Name of the Service. Object Type: string "order_no":0, #Order number of the Service. Object Type: integer }], #List of Service Orders to be updated. Object Type: array + } """ url_path = "/config/service/reorder" @@ -3177,6 +3309,7 @@ def new_tacacs_service_dictionary(self, body=({})): Required Body Parameters:['name', 'display_name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of TACACS+ Service Dictionary. Object Type: string "display_name" : "", #Display Name of TACACS+ Service Dictionary. Object Type: string @@ -3186,6 +3319,7 @@ def new_tacacs_service_dictionary(self, body=({})): "attr_type":"", #TACACS+ Service Dictionary Attribute Data Type. Object Type: string "allowed_values":"", #Allowed Values for TACACS+ Service Dictionary Attributes in CSV format. Object Type: string }], #List of TACACS+ Service Dictionary Attributes. Object Type: array + } """ url_path = "/tacacs-service-dictionary" @@ -3218,6 +3352,7 @@ def update_tacacs_service_dictionary_by_tacacs_service_dictionary_id( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of TACACS+ Service Dictionary. Object Type: string "display_name" : "", #Display Name of TACACS+ Service Dictionary. Object Type: string @@ -3227,6 +3362,7 @@ def update_tacacs_service_dictionary_by_tacacs_service_dictionary_id( "attr_type":"", #TACACS+ Service Dictionary Attribute Data Type. Object Type: string "allowed_values":"", #Allowed Values for TACACS+ Service Dictionary Attributes in CSV format. Object Type: string }], #List of TACACS+ Service Dictionary Attributes. Object Type: array + } """ url_path = "/tacacs-service-dictionary/{tacacs_service_dictionary_id}" @@ -3248,6 +3384,7 @@ def replace_tacacs_service_dictionary_by_tacacs_service_dictionary_id( Required Body Parameters:['name', 'display_name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of TACACS+ Service Dictionary. Object Type: string "display_name" : "", #Display Name of TACACS+ Service Dictionary. Object Type: string @@ -3257,6 +3394,7 @@ def replace_tacacs_service_dictionary_by_tacacs_service_dictionary_id( "attr_type":"", #TACACS+ Service Dictionary Attribute Data Type. Object Type: string "allowed_values":"", #Allowed Values for TACACS+ Service Dictionary Attributes in CSV format. Object Type: string }], #List of TACACS+ Service Dictionary Attributes. Object Type: array + } """ url_path = "/tacacs-service-dictionary/{tacacs_service_dictionary_id}" @@ -3302,6 +3440,7 @@ def update_tacacs_service_dictionary_name_by_name(self, name="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of TACACS+ Service Dictionary. Object Type: string "display_name" : "", #Display Name of TACACS+ Service Dictionary. Object Type: string @@ -3311,6 +3450,7 @@ def update_tacacs_service_dictionary_name_by_name(self, name="", body=({})): "attr_type":"", #TACACS+ Service Dictionary Attribute Data Type. Object Type: string "allowed_values":"", #Allowed Values for TACACS+ Service Dictionary Attributes in CSV format. Object Type: string }], #List of TACACS+ Service Dictionary Attributes. Object Type: array + } """ url_path = "/tacacs-service-dictionary/name/{name}" @@ -3330,6 +3470,7 @@ def replace_tacacs_service_dictionary_name_by_name(self, name="", body=({})): Required Body Parameters:['name', 'display_name', 'attributes'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "name" : "", #Name of TACACS+ Service Dictionary. Object Type: string "display_name" : "", #Display Name of TACACS+ Service Dictionary. Object Type: string @@ -3339,6 +3480,7 @@ def replace_tacacs_service_dictionary_name_by_name(self, name="", body=({})): "attr_type":"", #TACACS+ Service Dictionary Attribute Data Type. Object Type: string "allowed_values":"", #Allowed Values for TACACS+ Service Dictionary Attributes in CSV format. Object Type: string }], #List of TACACS+ Service Dictionary Attributes. Object Type: array + } """ url_path = "/tacacs-service-dictionary/name/{name}" diff --git a/pyclearpass/api_sessioncontrol.py b/pyclearpass/api_sessioncontrol.py index 724f6f5..b3c9b59 100644 --- a/pyclearpass/api_sessioncontrol.py +++ b/pyclearpass/api_sessioncontrol.py @@ -52,9 +52,11 @@ def new_session_by_id_disconnect(self, id="", body=({})): Required Body Parameters:['id', 'confirm_disconnect'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "id" : "", #ID of the session to disconnect. Object Type: string "confirm_disconnect" : False, #Flag to confirm disconnecting the active session. Object Type: boolean + } """ url_path = "/session/{id}/disconnect" @@ -90,9 +92,11 @@ def new_session_by_id_reauthorize(self, id="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "confirm_reauthorize" : False, #Flag to confirm the session reauthorization. Object Type: boolean "reauthorize_profile" : "", #Specify the name of the reauthorization profile to apply to the session. Object Type: string + } """ url_path = "/session/{id}/reauthorize" @@ -113,10 +117,12 @@ def new_session_action_disconnect(self, async_="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/disconnect" @@ -138,10 +144,12 @@ def new_session_action_disconnect_mac_by_mac_address( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/disconnect/mac/{mac_address}" @@ -166,10 +174,12 @@ def new_session_action_disconnect_username_by_username( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/disconnect/username/{username}" @@ -194,10 +204,12 @@ def new_session_action_disconnect_ip_by_client_ip_address( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/disconnect/ip/{client_ip_address}" @@ -219,10 +231,12 @@ def new_session_action_coa(self, async_="", body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/coa" @@ -244,10 +258,12 @@ def new_session_action_coa_mac_by_mac_address( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/coa/mac/{mac_address}" @@ -272,10 +288,12 @@ def new_session_action_coa_username_by_username( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/coa/username/{username}" @@ -300,10 +318,12 @@ def new_session_action_coa_ip_by_client_ip_address( Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "filter" : {}, #JSON filter expression specifying the items to return, e.g. "filter":{"username":"admin", ...}. Object Type: object "enforcement_profile" : {}, #When performing CoA, the 'enforcement_profile' parameter MUST be provided, e.g. "enforcement_profile":["...", "...'"]. Object Type: object "sort" : "", #Sorting the result set, e.g. "sort": "-id". Object Type: string + } """ url_path = "/session-action/coa/ip/{client_ip_address}" diff --git a/pyclearpass/api_toolsandutilities.py b/pyclearpass/api_toolsandutilities.py index a6334d1..7b2d2ff 100644 --- a/pyclearpass/api_toolsandutilities.py +++ b/pyclearpass/api_toolsandutilities.py @@ -17,6 +17,7 @@ def new_email_send(self, body=({})): Required Body Parameters:['to', 'message'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "to" : {}, #List of Recipients Email Address (e.g., ["a@example.com", "b@example.com"]). Object Type: object "subject" : "", #Email Subject. Object Type: string @@ -24,6 +25,7 @@ def new_email_send(self, body=({})): "cc_recipients" : {}, #List of CC recipients Email Address (e.g., ["a@example.com", "b@example.com"]). Object Type: object "bcc_recipients" : {}, #List of BCC recipients Email Address (e.g., ["a@example.com", "b@example.com"]). Object Type: object "headers" : {}, #Email headers (e.g., {"Content-Type":"text/plain; charset=UTF-8","Content-Transfer-Encoding": "8bit"}). Object Type: object + } """ url_path = "/email/send" @@ -48,10 +50,12 @@ def new_random_mpsk(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "random_mpsk_method" : "", #The random MPSK method. See the documentation for the allowed values.. Object Type: string "random_mpsk_length" : 0, #The desired length of the MPSK.. Object Type: integer "random_mpsk_picture" : "", #The picture to be used for the ‘nwa_picture_password’ method. See the documentation for the valid syntax.. Object Type: string + } """ url_path = "/random-mpsk" @@ -76,10 +80,12 @@ def new_random_password(self, body=({})): Required Body Parameters: None listed Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "random_password_method" : "", #The random password method. See the documentation for the allowed values.. Object Type: string "random_password_length" : 0, #The desired length of the password.. Object Type: integer "random_password_picture" : "", #The picture to be used for the ‘nwa_picture_password’ method. See the documentation for the valid syntax.. Object Type: string + } """ url_path = "/random-password" @@ -96,11 +102,13 @@ def new_sms_send(self, body=({})): Required Body Parameters:['recipient', 'message'] Parameter Type: body, Name: body Body example with descriptions and object types below (type(dict): + body={ "handler" : 0, #Select the service to use when sending the message. Object Type: integer "recipient" : "", #Enter the mobile telephone number of the recipient in international format. Object Type: string "carrier" : "", #The visitor’s mobile carrier. Object Type: string "message" : "", #Enter the message to send (maximum 160 characters). Object Type: string + } """ url_path = "/sms/send"